IL Core Implementation Guide
0.18.0 - draft
Publication Build: This will be filled in by the publication tooling
| Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-library | Version: 0.18.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: ILCoreLibrary | ||
Israel Core proposed constraints and extensions on the Library Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | Library | Israel Core Library Profile | |
![]() ![]() |
0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Library | Israel Core Library Profile lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
![]() ![]() |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Library.type | extensible | LibraryTypehttp://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Library | Israel Core Library Profile lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
![]() ![]() |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the library | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the library was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Library.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Library.type | extensible | LibraryTypehttp://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard |
Differential View
This structure is derived from Library
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | Library | Israel Core Library Profile | |
![]() ![]() |
0..1 | CodeableConcept, Reference(Group) | Type of individual the library content is focused on Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Library | Israel Core Library Profile lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. |
![]() ![]() |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||
![]() ![]() ![]() |
CodeableConcept | |||
![]() ![]() ![]() |
Reference(Group) | |||
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Library.type | extensible | LibraryTypehttp://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | |
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Library | Israel Core Library Profile lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this library, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the library | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the library | ||||
![]() ![]() |
ΣC | 0..1 | string | Name for this library (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this library (human friendly) | ||||
![]() ![]() |
0..1 | string | Subordinate title of the library | |||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition Binding: LibraryType (extensible): The type of knowledge asset this library contains. | ||||
![]() ![]() |
0..1 | Type of individual the library content is focused on Slice: Unordered, Open by type:$this Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.). | ||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Reference(Group) | |||||||
![]() ![]() ![]() |
0..1 | Reference(ILCore Group Profile) | Type of individual the library content is focused on | |||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the library | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
0..1 | markdown | Why this library is defined | |||||
![]() ![]() |
0..1 | string | Describes the clinical usage of the library | |||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the library was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the library was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the library is expected to be used | ||||
![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering. | |||||
![]() ![]() |
0..* | ContactDetail | Who authored the content | |||||
![]() ![]() |
0..* | ContactDetail | Who edited the content | |||||
![]() ![]() |
0..* | ContactDetail | Who reviewed the content | |||||
![]() ![]() |
0..* | ContactDetail | Who endorsed the content | |||||
![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
![]() ![]() |
0..* | ParameterDefinition | Parameters defined by the library | |||||
![]() ![]() |
0..* | DataRequirement | What data is referenced by this library | |||||
![]() ![]() |
Σ | 0..* | Attachment | Contents of the library, either embedded or referenced | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Library.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Library.type | extensible | LibraryTypehttp://hl7.org/fhir/ValueSet/library-typefrom the FHIR Standard | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Library.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron