DDS-Report-Substance-1-0
Substance | |
Definition | A homogeneous material with a definite composition. |
Control | 0..* |
Type | Substance |
Comments | |
Substance.identifier | |
Definition | Unique identifier for the substance. |
Control | 0..1 |
Type | Identifier |
Comments | This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container. |
Substance.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Example | official |
Substance.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Substance.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Substance.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establishes the system clearly and unambiguously. |
Substance.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | String |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Substance.identifier.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Substance.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Substance.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | Boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Substance.identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Example | Identifier allocated by manufacturing pharmaceutical company. |
Substance.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.pharm.com/Id/substance-id |
Substance.identifier.value | |
Definition | The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | AEB22D1D-0DBF-426C-B86C-3F47DCA4A4E8 |
Substance.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Comments | |
Substance.identifier.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 1..1 ? |
Type | DateTime |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Substance.identifier.period.end | |
Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Substance.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Organization |
Comments | The reference may be just a text description of the assigner. |
Substance.identifier.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | Organization/0A6F71A7-161D-4A84-8573-AB55DBB19340 |
Substance.identifier.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | Pharm Pharmaceuticals Limited |
Substance.category | |
Definition | A code that classifies the general type of substance. This is used for searching, sorting and display purposes. |
Control | 0..* |
Binding | Category or classification of substance The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/substance-category |
Type | CodeableConcept |
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. |
Substance.category.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Substance.category.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://hl7.org.fhir/substance-category |
Substance.category.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | String |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Substance.category.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Example | drug |
Substance.category.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Example | Drug or Medicament |
Substance.category.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | Boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Substance.category.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Substance.code | |
Definition | A code (or set of codes) that identify this substance. |
Control | 1..1 |
Binding | Substance codes For example codes, see http://snomed.info/sct; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
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. |
Substance.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Substance.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Substance.code.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | String |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Substance.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Example | 392259005 |
Substance.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Example | co-amoxiclav 875mg/125mg tablet |
Substance.code.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | Boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Substance.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Substance.description | |
Definition | A description of the substance - its appearance, handling requirements, and other usage notes. |
Control | 0..1 |
Type | String |
Comments | |
Example | Augmentin 875 |
Substance.instance | |
Definition | Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. |
Control | 0..1 |
Type | BackboneElement |
Comments | |
Substance.instance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Substance.instance.identifier | |
Definition | Identifier associated with the package/container (usually a label affixed directly). |
Control | 0..1 |
Type | Identifier |
Comments | |
Substance.instance.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Example | official |
Substance.instance.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Substance.instance.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Substance.instance.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | Uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Substance.instance.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | String |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Substance.instance.identifier.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | Code |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Substance.instance.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 1..1 |
Type | String |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Substance.instance.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | Boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Substance.instance.identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | String |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Example | Identifier for the package containing the tablets allocated by manufacturing pharmaceutical company. |
Substance.instance.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | Uri |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.pharm.com/Id/package-id |
Substance.instance.identifier.value | |
Definition | The portion of the identifier typically displayed to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | String |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | D8BF142A-525E-4107-BB4D-67516DF492DA |
Substance.instance.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Comments | |
Substance.instance.identifier.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 1..1 ? |
Type | DateTime |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Substance.instance.identifier.period.end | |
Definition | The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Substance.instance.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Organization |
Comments | The reference may be just a text description of the assigner. |
Substance.instance.identifier.assigner.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | Organization/0A6F71A7-161D-4A84-8573-AB55DBB19340 |
Substance.instance.identifier.assigner.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | Pharm Pharmaceuticals Limited |
Substance.instance.expiry | |
Definition | When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry. |
Control | 0..1 |
Type | DateTime |
Comments | |
Substance.instance.quantity | |
Definition | The amount of the substance. |
Control | 0..1 |
Type | Quantity |
Comments | |
Substance.instance.quantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | Decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Substance.instance.quantity.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..1 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Substance.instance.quantity.unit | |
Definition | A human-readable form of the unit. |
Control | 1..1 |
Type | String |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | |
Substance.instance.quantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 ? |
Type | Uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | |
Substance.instance.quantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 0..1 |
Type | Code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Substance.ingredient | |
Definition | A substance can be composed of other substances. |
Control | 0..* |
Type | BackboneElement |
Comments | |
Substance.ingredient.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Substance.ingredient.quantity | |
Definition | The amount of the ingredient in the substance - a concentration ratio. |
Control | 1..1 |
Type | Ratio |
Comments | |
Substance.ingredient.quantity.numerator | |
Definition | The value of the numerator. |
Control | 1..1 |
Type | Quantity |
Comments | |
Substance.ingredient.quantity.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | Decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Example | 875 |
Substance.ingredient.quantity.numerator.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..1 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Substance.ingredient.quantity.numerator.unit | |
Definition | A human-readable form of the unit. |
Control | 1..1 |
Type | String |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | |
Example | milligram |
Substance.ingredient.quantity.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 ? |
Type | Uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | |
Example | http://unitsofmeasure.org |
Substance.ingredient.quantity.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | Code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Example | mg |
Substance.ingredient.quantity.denominator | |
Definition | The value of the denominator. |
Control | 1..1 |
Type | Quantity |
Comments | |
Substance.ingredient.quantity.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | Decimal |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
Example | 1000 |
Substance.ingredient.quantity.denominator.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..1 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Substance.ingredient.quantity.denominator.unit | |
Definition | A human-readable form of the unit. |
Control | 1..1 |
Type | String |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Comments | |
Example | milligram |
Substance.ingredient.quantity.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 ? |
Type | Uri |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | |
Example | http://unitsofmeasure.org |
Substance.ingredient.quantity.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | Code |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
Example | mg |
Substance.ingredient.substance | |
Definition | Another substance that is a component of this substance. |
Control | 1..1 |
Type | Substance |
Comments | |
Substance.ingredient.substance.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 1..1 ? |
Type | String |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Example | #ingr1 |
Substance.ingredient.substance.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | String |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Example | Amoxicillin |