International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Draft as of 2024-08-04 |
Definitions for the 2.16.840.1.113883.10.22.4.15--20240804212024 logical model.
Guidance on how to interpret the contents of this table can be found here
0. SubstanceAdministration | |
Control | 0..* |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. SubstanceAdministration.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on SubstanceAdministration.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. SubstanceAdministration.templateId:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. SubstanceAdministration.templateId:primary.root | |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.4.15 |
8. SubstanceAdministration.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SBADM |
10. SubstanceAdministration.moodCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
12. SubstanceAdministration.id | |
Control | 0..* |
14. SubstanceAdministration.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709 (required to urn:oid:2.16.840.1.113883.1.11.19709 )ActSubstanceAdministrationImmunizationCode |
Must Support | true |
16. SubstanceAdministration.statusCode | |
Control | 1..1 |
Must Support | true |
18. SubstanceAdministration.statusCode.code | |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | completed |
20. SubstanceAdministration.effectiveTime | |
Control | 1..1 |
Must Support | true |
22. SubstanceAdministration.consumable | |
Control | 1..1 |
Must Support | true |
24. SubstanceAdministration.consumable.manufacturedProduct | |
Control | 0..* |
26. SubstanceAdministration.consumable.manufacturedProduct.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
28. SubstanceAdministration.consumable.manufacturedProduct.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
32. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.root | |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.4.16 |
34. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial | |
Control | 1..1 |
Must Support | true |
36. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code | |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Vaccines WHO ATC (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines |
Must Support | true |
38. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation | |
Control | 1..? |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
40. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
42. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary | |
Slice Name | secondary |
Definition | candidate: for when WHO ATC code system is preferred |
Control | 1..1 |
Binding | The codes SHALL be taken from IPS Vaccines WHO ATC (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines WHO ATC |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
44. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText | |
Control | 0..1 |
46. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization | |
Control | 0..1 |
Must Support | true |
48. SubstanceAdministration.author | |
Control | 0..* |
Must Support | true |
50. SubstanceAdministration.entryRelationship | |
Control | 1..? |
Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
52. SubstanceAdministration.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Invariants | entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) () |
54. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RSON |
56. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration) |
Guidance on how to interpret the contents of this table can be found here
0. SubstanceAdministration | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. SubstanceAdministration.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on SubstanceAdministration.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. SubstanceAdministration.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. SubstanceAdministration.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.15 |
8. SubstanceAdministration.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SBADM |
10. SubstanceAdministration.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
12. SubstanceAdministration.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
14. SubstanceAdministration.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709 (required to urn:oid:2.16.840.1.113883.1.11.19709 )ActSubstanceAdministrationImmunizationCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
16. SubstanceAdministration.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
18. SubstanceAdministration.statusCode.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Fixed Value | completed |
20. SubstanceAdministration.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
22. SubstanceAdministration.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
24. SubstanceAdministration.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
26. SubstanceAdministration.statusCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
28. SubstanceAdministration.statusCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
30. SubstanceAdministration.statusCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
32. SubstanceAdministration.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
34. SubstanceAdministration.effectiveTime | |
Control | 1..1 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
XML Format | The type of this property is determined using the xsi:type attribute. |
36. SubstanceAdministration.consumable | |
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
Must Support | true |
38. SubstanceAdministration.consumable.manufacturedProduct | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
40. SubstanceAdministration.consumable.manufacturedProduct.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
42. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
44. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.16 |
46. SubstanceAdministration.consumable.manufacturedProduct.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from RoleClassManufacturedProduct (required to http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
48. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material |
Must Support | true |
50. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code | |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Vaccines WHO ATC (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
52. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
54. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
56. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary | |
Slice Name | primary |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
58. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary | |
Slice Name | secondary |
Definition | candidate: for when WHO ATC code system is preferred |
Control | 1..1 |
Binding | The codes SHALL be taken from IPS Vaccines WHO ATC (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines WHO ATC |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
60. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
62. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
Must Support | true |
64. SubstanceAdministration.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
Must Support | true |
66. SubstanceAdministration.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
68. SubstanceAdministration.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Invariants | entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) () |
70. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RSON |
72. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration |
Short | Base for all types and resources |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration) |
Is Modifier | false |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. SubstanceAdministration | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. SubstanceAdministration.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. SubstanceAdministration.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. SubstanceAdministration.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. SubstanceAdministration.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. SubstanceAdministration.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. SubstanceAdministration.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. SubstanceAdministration.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. SubstanceAdministration.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. SubstanceAdministration.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on SubstanceAdministration.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. SubstanceAdministration.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
22. SubstanceAdministration.templateId:primary.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
24. SubstanceAdministration.templateId:primary.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
26. SubstanceAdministration.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
28. SubstanceAdministration.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.15 |
30. SubstanceAdministration.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
32. SubstanceAdministration.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAActClass (required to http://hl7.org/cda/stds/core/ValueSet/CDAActClass ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | SBADM |
34. SubstanceAdministration.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from XDocumentSubstanceMood (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-xDocumentSubstanceMood|2.0.0 ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | EVN |
36. SubstanceAdministration.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
38. SubstanceAdministration.code | |
Control | 1..1 |
Binding | The codes SHALL be taken from urn:oid:2.16.840.1.113883.1.11.19709 (required to urn:oid:2.16.840.1.113883.1.11.19709 )ActSubstanceAdministrationImmunizationCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
40. SubstanceAdministration.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
42. SubstanceAdministration.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
44. SubstanceAdministration.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
46. SubstanceAdministration.statusCode.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
48. SubstanceAdministration.statusCode.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
Fixed Value | completed |
50. SubstanceAdministration.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
52. SubstanceAdministration.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
54. SubstanceAdministration.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
56. SubstanceAdministration.statusCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
58. SubstanceAdministration.statusCode.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSet . |
60. SubstanceAdministration.statusCode.sdtcValueSetVersion | |
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSetVersion . |
62. SubstanceAdministration.statusCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
64. SubstanceAdministration.statusCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
66. SubstanceAdministration.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
68. SubstanceAdministration.effectiveTime | |
Control | 1..1 |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXCM-TS |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
XML Format | The type of this property is determined using the xsi:type attribute. |
70. SubstanceAdministration.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
72. SubstanceAdministration.repeatNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-INT |
74. SubstanceAdministration.routeCode | |
Control | 0..1 |
Binding | For example codes, see RouteOfAdministration (example to http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
76. SubstanceAdministration.approachSiteCode | |
Control | 0..* |
Binding | For example codes, see v3 Value Set ActSite (example to http://terminology.hl7.org/ValueSet/v3-ActSite ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
78. SubstanceAdministration.doseQuantity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
80. SubstanceAdministration.rateQuantity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ |
82. SubstanceAdministration.maxDoseQuantity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ |
84. SubstanceAdministration.administrationUnitCode | |
Control | 0..1 |
Binding | For example codes, see AdministrableDrugForm (example to http://terminology.hl7.org/ValueSet/v3-AdministrableDrugForm ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
86. SubstanceAdministration.consumable | |
Definition | The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot |
Must Support | true |
88. SubstanceAdministration.consumable.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
90. SubstanceAdministration.consumable.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
92. SubstanceAdministration.consumable.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
94. SubstanceAdministration.consumable.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
96. SubstanceAdministration.consumable.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
98. SubstanceAdministration.consumable.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
100. SubstanceAdministration.consumable.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
102. SubstanceAdministration.consumable.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
104. SubstanceAdministration.consumable.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
106. SubstanceAdministration.consumable.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | CSM |
108. SubstanceAdministration.consumable.manufacturedProduct | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ManufacturedProduct |
110. SubstanceAdministration.consumable.manufacturedProduct.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
112. SubstanceAdministration.consumable.manufacturedProduct.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
114. SubstanceAdministration.consumable.manufacturedProduct.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
116. SubstanceAdministration.consumable.manufacturedProduct.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
118. SubstanceAdministration.consumable.manufacturedProduct.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
120. SubstanceAdministration.consumable.manufacturedProduct.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
122. SubstanceAdministration.consumable.manufacturedProduct.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
124. SubstanceAdministration.consumable.manufacturedProduct.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
126. SubstanceAdministration.consumable.manufacturedProduct.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
128. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary | |
Slice Name | primary |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
130. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
132. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
134. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
136. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.16 |
138. SubstanceAdministration.consumable.manufacturedProduct.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
140. SubstanceAdministration.consumable.manufacturedProduct.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from RoleClassManufacturedProduct (required to http://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
142. SubstanceAdministration.consumable.manufacturedProduct.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
144. SubstanceAdministration.consumable.manufacturedProduct.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
146. SubstanceAdministration.consumable.manufacturedProduct.manufacturedLabeledDrug | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug |
148. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material |
Must Support | true |
150. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
152. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
154. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
156. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
158. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
160. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
162. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
164. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
166. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
168. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityClassManufacturedMaterial (required to http://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MMAT |
170. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminerDetermined (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | KIND |
172. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code | |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Vaccines WHO ATC (preferred to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
174. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
176. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.code | |
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code |
178. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System |
180. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Name |
182. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Code System Version |
184. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Display Name |
186. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(oid: ISO Object Identifier) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSet . |
188. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.sdtcValueSetVersion | |
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namevalueSetVersion . |
190. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Original Text |
192. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
Label | Qualifier |
194. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
Slicing | This element introduces a set of slices on SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
196. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:primary | |
Slice Name | primary |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
198. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.code.translation:secondary | |
Slice Name | secondary |
Definition | candidate: for when WHO ATC code system is preferred |
Control | 1..1 |
Binding | The codes SHALL be taken from IPS Vaccines WHO ATC (required to http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips )IPS Vaccines WHO ATC |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
200. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.name | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN |
202. SubstanceAdministration.consumable.manufacturedProduct.manufacturedMaterial.lotNumberText | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST |
204. SubstanceAdministration.consumable.manufacturedProduct.manufacturerOrganization | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
Must Support | true |
206. SubstanceAdministration.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
208. SubstanceAdministration.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
210. SubstanceAdministration.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
212. SubstanceAdministration.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
Must Support | true |
214. SubstanceAdministration.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
216. SubstanceAdministration.participant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
218. SubstanceAdministration.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on SubstanceAdministration.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
220. SubstanceAdministration.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Invariants | entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2023-01-30) () |
222. SubstanceAdministration.entryRelationship:entryRelationship-1.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
224. SubstanceAdministration.entryRelationship:entryRelationship-1.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
226. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
228. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
230. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
232. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
234. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
236. SubstanceAdministration.entryRelationship:entryRelationship-1.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
238. SubstanceAdministration.entryRelationship:entryRelationship-1.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
240. SubstanceAdministration.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | RSON |
242. SubstanceAdministration.entryRelationship:entryRelationship-1.inversionInd | |
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
244. SubstanceAdministration.entryRelationship:entryRelationship-1.contextConductionInd | |
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
246. SubstanceAdministration.entryRelationship:entryRelationship-1.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
248. SubstanceAdministration.entryRelationship:entryRelationship-1.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
250. SubstanceAdministration.entryRelationship:entryRelationship-1.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
252. SubstanceAdministration.entryRelationship:entryRelationship-1.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
254. SubstanceAdministration.entryRelationship:entryRelationship-1.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
256. SubstanceAdministration.entryRelationship:entryRelationship-1.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
258. SubstanceAdministration.entryRelationship:entryRelationship-1.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
260. SubstanceAdministration.entryRelationship:entryRelationship-1.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
262. SubstanceAdministration.entryRelationship:entryRelationship-1.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
264. SubstanceAdministration.entryRelationship:entryRelationship-1.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
266. SubstanceAdministration.entryRelationship:entryRelationship-1.substanceAdministration:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | The moodCode of this subordinate substance administration SHALL be the same of the parent substance administration |
Short | Base for all types and resources |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration(UV Subordinate Substance Administration) |
Is Modifier | false |
Must Support | true |
268. SubstanceAdministration.entryRelationship:entryRelationship-1.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
270. SubstanceAdministration.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
272. SubstanceAdministration.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
274. SubstanceAdministration.sdtcInFulfillmentOf1 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameinFulfillmentOf1 . |