CH LAB-Report (R4)
1.0.0-ballot - ballot
This page is part of the CH LAB-Report (R4) (v1.0.0-ballot: STU 1 Ballot 1) 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.ch/ig/ch-lab-report/StructureDefinition/specimen-additive-substance-eu-lab | Version: 1.0.0-ballot | |||
Active as of 2024-05-17 | Computable Name: SpecimenAdditiveSubstance | |||
Copyright/Legal: CC0-1.0 |
This profile defines how to represent Specimen Additive Substances in HL7 FHIR for the purpose of this guide.
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 | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) | |
![]() |
Path | Conformance | ValueSet | URI |
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) |
![]() |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | |
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | |||||
![]() ![]() ![]() |
Σ | 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..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Textual description of the substance, comments | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier of the package/container | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When no longer valid to use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Amount of substance in the package | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Composition information about the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | ||||
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | ||||
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab | ||||
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() |
This structure is derived from Substance
Differential View
This structure is derived from Substance
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
Substance | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) | |
![]() |
Path | Conformance | ValueSet | URI |
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) |
![]() |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | |
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Substance | A homogeneous material with a definite composition | |||||
![]() ![]() ![]() |
Σ | 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..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | What substance this is Binding: Specimen Additive (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Textual description of the substance, comments | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier of the package/container | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | When no longer valid to use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SimpleQuantity | Amount of substance in the package | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Composition information about the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||
![]() |
Path | Conformance | ValueSet | URI | |||
Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | ||||
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | ||||
Substance.code | preferred | LabSpecimenAdditiveEuhttp://hl7.eu/fhir/laboratory/ValueSet/lab-specimenAdditive-eu-lab | ||||
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() |
This structure is derived from Substance
Other representations of profile: CSV, Excel, Schematron