Medizininformatik Initiative - Modul Biobank

Substance (Additiv)

Mittels einer Substance wird ein Additv abgebildet.

Canonical: https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Substance

Differential

Substance	I		Substance	There are no (further) constraints on this element Element Id Substance Short description A homogeneous material with a definite composition Definition A homogeneous material with a definite composition. Data Type Substance Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:Material orim:fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\#MAT ].
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Substance.identifier Short description Unique identifier Definition Unique identifier for the substance. Comments This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
status	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Substance.status Short description active \| inactive \| entered-in-error Definition A code to indicate if the substance is actively used. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding A code to indicate if the substance is actively used. FHIRSubstanceStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
category	S Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Substance.category Short description What class/type of substance this is Definition A code that classifies the general type of substance. This is used for searching, sorting and display purposes. Comments The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code. Data Type CodeableConcept Binding Category or classification of substance. SubstanceCategoryCodes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.code
code	S Σ	1..1	CodeableConceptBinding	Element Id Substance.code Short description What substance this is Definition A code (or set of codes) that identify this substance. Comments This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes. Data Type CodeableConcept Binding Substance codes. ValueSetAdditive (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.what[x] rim:.code orim:fhir:Substance.code rdfs:subPropertyOf rim:Entity.code
description	Σ	0..1	string	There are no (further) constraints on this element Element Id Substance.description Short description Textual description of the substance, comments Definition A description of the substance - its appearance, handling requirements, and other usage notes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.desc
instance	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id Substance.instance Short description If this describes a specific package/container of the substance Definition Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. Meaning When Missing If this element is not present, then the substance resource describes a kind of substance Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.determinerCode
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Substance.instance.identifier Short description Identifier of the package/container Definition Identifier associated with the package/container (usually a label affixed directly). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.id
expiry	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id Substance.instance.expiry Short description When no longer valid to use Definition When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.expiryTime
quantity	Σ I	0..1	SimpleQuantity	There are no (further) constraints on this element Element Id Substance.instance.quantity Short description Amount of substance in the package Definition The amount of the substance. Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. Data Type SimpleQuantity Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3:If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()` sqty-1:The comparator is not used on a SimpleQuantity `comparator.empty()` Mappings rim:n/a v2:SN (see also Range) or CQ rim:PQ, IVL<PQ>, MO, CO, depending on the values rim:.player.quantity
ingredient	S Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id Substance.ingredient Short description Composition information about the substance Definition A substance can be composed of other substances. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.scopesRole[classCode=INGR]
quantity	Σ I	0..1	Ratio	There are no (further) constraints on this element Element Id Substance.ingredient.quantity Short description Optional amount (concentration) Definition The amount of the ingredient in the substance - a concentration ratio. Comments The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. Data Type Ratio Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` rat-1:Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present `(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())` Mappings rim:n/a v2:N/A rim:RTO rim:.quantity
substance[x]	Σ	1..1		There are no (further) constraints on this element Element Id Substance.ingredient.substance[x] Short description A component of the substance Definition Another substance that is a component of this substance. Binding Substance Ingredient codes. SubstanceCode (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player
substanceCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
substanceReference			Reference(Substance)	There are no (further) constraints on this element Data Type Reference(Substance)

FHIR Element	Erklärung
code	Code des Zusatzstoffes, bevorzugt in SNOMED CT.

FHIR Element	Logischer Datensatz
code	Biobank.Bioprobe.Primaercontainer.Additiv / Biobank.Bioprobe.Verarbeitungsprozess.Additiv

Snapshot

Substance	I		Substance	There are no (further) constraints on this element Element Id Substance Short description A homogeneous material with a definite composition Definition A homogeneous material with a definite composition. Data Type Substance Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:Material orim:fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\#MAT ].
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id Substance.identifier Short description Unique identifier Definition Unique identifier for the substance. Comments This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier rim:.id
status	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Substance.status Short description active \| inactive \| entered-in-error Definition A code to indicate if the substance is actively used. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding A code to indicate if the substance is actively used. FHIRSubstanceStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:.statusCode
category	S Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id Substance.category Short description What class/type of substance this is Definition A code that classifies the general type of substance. This is used for searching, sorting and display purposes. Comments The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code. Data Type CodeableConcept Binding Category or classification of substance. SubstanceCategoryCodes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.class rim:.code
code	S Σ	1..1	CodeableConceptBinding	Element Id Substance.code Short description What substance this is Definition A code (or set of codes) that identify this substance. Comments This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes. Data Type CodeableConcept Binding Substance codes. ValueSetAdditive (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD w5:FiveWs.what[x] rim:.code orim:fhir:Substance.code rdfs:subPropertyOf rim:Entity.code
description	Σ	0..1	string	There are no (further) constraints on this element Element Id Substance.description Short description Textual description of the substance, comments Definition A description of the substance - its appearance, handling requirements, and other usage notes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.desc
instance	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id Substance.instance Short description If this describes a specific package/container of the substance Definition Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. Meaning When Missing If this element is not present, then the substance resource describes a kind of substance Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.determinerCode
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id Substance.instance.identifier Short description Identifier of the package/container Definition Identifier associated with the package/container (usually a label affixed directly). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.id
expiry	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id Substance.instance.expiry Short description When no longer valid to use Definition When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.expiryTime
quantity	Σ I	0..1	SimpleQuantity	There are no (further) constraints on this element Element Id Substance.instance.quantity Short description Amount of substance in the package Definition The amount of the substance. Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. Data Type SimpleQuantity Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3:If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()` sqty-1:The comparator is not used on a SimpleQuantity `comparator.empty()` Mappings rim:n/a v2:SN (see also Range) or CQ rim:PQ, IVL<PQ>, MO, CO, depending on the values rim:.player.quantity
ingredient	S Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id Substance.ingredient Short description Composition information about the substance Definition A substance can be composed of other substances. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player.scopesRole[classCode=INGR]
quantity	Σ I	0..1	Ratio	There are no (further) constraints on this element Element Id Substance.ingredient.quantity Short description Optional amount (concentration) Definition The amount of the ingredient in the substance - a concentration ratio. Comments The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. Data Type Ratio Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` rat-1:Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present `(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())` Mappings rim:n/a v2:N/A rim:RTO rim:.quantity
substance[x]	Σ	1..1		There are no (further) constraints on this element Element Id Substance.ingredient.substance[x] Short description A component of the substance Definition Another substance that is a component of this substance. Binding Substance Ingredient codes. SubstanceCode (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.player
substanceCodeableConcept			CodeableConcept	There are no (further) constraints on this element Data Type CodeableConcept
substanceReference			Reference(Substance)	There are no (further) constraints on this element Data Type Reference(Substance)

Beispiel

{
    "resourceType": "Substance",
    "id": "Heparin",
    "meta": {
        "profile":  [
            "https://www.medizininformatik-initiative.de/fhir/ext/modul-biobank/StructureDefinition/Substance"
        ]
    },
    "code": {
        "coding":  [
            {
                "code": "372877000",
                "system": "http://snomed.info/sct",
                "display": "Heparin (substance)"
            }
        ]
    }
}