3.0.0-alpha - ci-build
3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
| Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-Substance | Version: 3.0.0-alpha | |||
| Active as of 2019-07-03 | Computable Name: NoBasisSubstance | |||
Basis profile for Substances to be used in Norway. The profile is adapted to use FEST as source of information.
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 | A homogeneous material with a definite composition | |
  code | ||||
 concept | ||||
 Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open At End by value:system | |
  coding:FEST-Substance | 0..1 | Coding | Substance defined in FEST | |
 system | 1..1 | uri | FEST Fixed Value: http://ehelse.no/fhir/CodeSystem/FEST | |
| code | 1..1 | code | Substance Id in FEST | |
 display | 1..1 | string | Substance name from FEST | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| instance | ?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one |
| 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 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Substance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| 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: AllLanguages (required): IETF language tag for 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 |
| instance | ?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one |
| 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 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes. |
 id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open At End by value:system |
| coding:FEST-Substance | Σ | 0..1 | Coding | Substance defined in FEST |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | FEST Fixed Value: http://ehelse.no/fhir/CodeSystem/FEST |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 1..1 | code | Substance Id in FEST |
| display | ΣC | 1..1 | string | Substance name from FEST |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
| description | Σ | 0..1 | markdown | Textual description of the substance, comments |
| 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) |
 substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.language | required | AllLanguages |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.category | extensible | SubstanceCategoryCodes |
| Substance.code | example | SubstanceCode |
| Substance.ingredient.substance[x] | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Substance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| code | ||||
| concept | ||||
| Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open At End by value:system | |
| coding:FEST-Substance | 0..1 | Coding | Substance defined in FEST | |
| system | 1..1 | uri | FEST Fixed Value: http://ehelse.no/fhir/CodeSystem/FEST | |
| code | 1..1 | code | Substance Id in FEST | |
| display | 1..1 | string | Substance name from FEST | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| instance | ?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one |
| 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 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.code | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Substance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | 0..* | Substance | A homogeneous material with a definite composition | |
| 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: AllLanguages (required): IETF language tag for 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 |
| instance | ?!Σ | 1..1 | boolean | Is this an instance of a substance or a kind of one |
| 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 | CodeableReference(SubstanceDefinition) | What substance this is Binding: SubstanceCode (example): Substance codes. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| concept | Σ | 0..1 | CodeableConcept | Reference to a concept (by class) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open At End by value:system |
| coding:FEST-Substance | Σ | 0..1 | Coding | Substance defined in FEST |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system | Σ | 1..1 | uri | FEST Fixed Value: http://ehelse.no/fhir/CodeSystem/FEST |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | ΣC | 1..1 | code | Substance Id in FEST |
| display | ΣC | 1..1 | string | Substance name from FEST |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) |
| description | Σ | 0..1 | markdown | Textual description of the substance, comments |
| 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) |
| substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
| substanceCodeableConcept | CodeableConcept | |||
| substanceReference | Reference(Substance) | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Substance.language | required | AllLanguages |
| Substance.status | required | FHIRSubstanceStatus |
| Substance.category | extensible | SubstanceCategoryCodes |
| Substance.code | example | SubstanceCode |
| Substance.ingredient.substance[x] | example | SubstanceCode |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron