IL Core Implementation Guide
0.18.0 - draft
IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-substance | Version: 0.18.0 | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: ILCoreSubstance | ||
Israel Core proposed constraints and extensions on the Substance Resource
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance |
0..* | Substance | ILCore Substance Profile | |
  ingredient |
||||
  Slices for substance[x] |
1..1 | CodeableConcept, Reference(Substance) | A component of the substance Slice: Unordered, Open by type:$this | |
  substance[x]:substanceReference |
0..1 | Reference(ILCore Substance Profile) | A component of the substance | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance |
0..* | Substance | ILCore Substance Profile | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
  code |
Σ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | |
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Substance |
0..* | Substance | ILCore Substance Profile | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique identifier | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | ||||
| category |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
| code |
Σ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | ||||
| description |
Σ | 0..1 | string | Textual description of the substance, comments | ||||
 instance |
Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 0..1 | Identifier | Identifier of the package/container | ||||
| expiry |
Σ | 0..1 | dateTime | When no longer valid to use | ||||
| quantity |
Σ | 0..1 | SimpleQuantity | Amount of substance in the package | ||||
| ingredient |
Σ | 0..* | BackboneElement | Composition information about the substance | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
| Slices for substance[x] |
Σ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
 substanceCodeableConcept |
CodeableConcept | |||||||
 substanceReference |
Reference(Substance) | |||||||
| substance[x]:substanceReference |
Σ | 0..1 | Reference(ILCore Substance Profile) | A component of the substance | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | ||||
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard | ||||
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard |
Differential View
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance |
0..* | Substance | ILCore Substance Profile | |
| ingredient |
||||
| Slices for substance[x] |
1..1 | CodeableConcept, Reference(Substance) | A component of the substance Slice: Unordered, Open by type:$this | |
| substance[x]:substanceReference |
0..1 | Reference(ILCore Substance Profile) | A component of the substance | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance |
0..* | Substance | ILCore Substance Profile | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
| code |
Σ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | |
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Substance |
0..* | Substance | ILCore Substance Profile | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Unique identifier | ||||
| status |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | ||||
| category |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
| code |
Σ | 1..1 | CodeableConcept | What substance this is Binding: SubstanceCode (example): Substance codes. | ||||
| description |
Σ | 0..1 | string | Textual description of the substance, comments | ||||
| instance |
Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 0..1 | Identifier | Identifier of the package/container | ||||
| expiry |
Σ | 0..1 | dateTime | When no longer valid to use | ||||
| quantity |
Σ | 0..1 | SimpleQuantity | Amount of substance in the package | ||||
| ingredient |
Σ | 0..* | BackboneElement | Composition information about the substance | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| quantity |
Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
| Slices for substance[x] |
Σ | 1..1 | A component of the substance Slice: Unordered, Open by type:$this Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
| substanceCodeableConcept |
CodeableConcept | |||||||
| substanceReference |
Reference(Substance) | |||||||
| substance[x]:substanceReference |
Σ | 0..1 | Reference(ILCore Substance Profile) | A component of the substance | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1from the FHIR Standard | ||||
| Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-categoryfrom the FHIR Standard | ||||
| Substance.code | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard | ||||
| Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-codefrom the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron