Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build
United States of America
This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
Definitions for the 2.16.840.1.113883.10.20.22.4.17 resource profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Supply | |
| 2. Supply.classCode | |
| Requirements | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427). |
| 3. Supply.moodCode | |
| Requirements | SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428). |
| Pattern Value | INT |
| 4. Supply.templateId | |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Supply.templateId:primary | |
| SliceName | primary |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7429) such that it |
| 6. Supply.templateId:primary.root | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.17" (CONF:1098-10507). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.17 |
| 7. Supply.templateId:primary.extension | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32578). |
| Pattern Value | 2014-06-09 |
| 8. Supply.id | |
| Control | 10..* |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7430). |
| 9. Supply.statusCode | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-7432). |
| 10. Supply.statusCode.code | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32362). |
| 11. Supply.effectiveTime | |
| Slicing | This element introduces a set of slices on Supply.effectiveTime. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Supply.effectiveTime:when | |
| SliceName | when |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it |
| 13. Supply.effectiveTime:when.high | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] high (CONF:1098-15144). |
| 14. Supply.repeatNumber | |
| Requirements | SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7434). |
| 15. Supply.quantity | |
| Requirements | SHOULD contain zero or one [0..1] quantity (CONF:1098-7436). |
| 16. Supply.product | |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-7439). |
| 17. Supply.product.manufacturedProduct | |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation, ImmunizationMedicationInformation) |
| Requirements | The product, if present, SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093). |
| 18. Supply.author | |
| Control | 0..1* |
| Requirements | MAY contain zero or one [0..1] author (CONF:1098-7438). |
| 19. Supply.entryRelationship | |
| Control | 0..1* |
| Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442). |
| 20. Supply.entryRelationship.typeCode | |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444). |
| Pattern Value | SUBJ |
| 21. Supply.entryRelationship.inversionInd | |
| Control | 10..1 |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445). |
| Pattern Value | true |
| 22. Supply.entryRelationship.act | |
| Control | 10..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(Instruction) |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391). |
Guidance on how to interpret the contents of this table can be found here.
| 1. Supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 10..1* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. Supply.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427). |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 3. Supply.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428). |
| Pattern Value | INT |
| 4. Supply.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/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Supply.templateId:primary | |
| SliceName | 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/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7429) such that it |
| 6. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.17" (CONF:1098-10507). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.17 |
| 7. Supply.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32578). |
| Pattern Value | 2014-06-09 |
| 8. Supply.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7430). |
| 9. Supply.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-7432). |
| 10. Supply.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 | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32362). |
| 11. Supply.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 12. Supply.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 13. Supply.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 14. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 15. Supply.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 16. Supply.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 17. Supply.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/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 18. Supply.effectiveTime | |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Slicing | This element introduces a set of slices on Supply.effectiveTime. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 19. Supply.effectiveTime:when | |
| SliceName | when |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it |
| 20. Supply.effectiveTime:when.high | |
| Definition | This is the high limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | SHALL contain exactly one [1..1] high (CONF:1098-15144). |
| 21. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| Requirements | SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7434). |
| 22. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| Requirements | SHOULD contain zero or one [0..1] quantity (CONF:1098-7436). |
| 23. Supply.product | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-7439). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 24. Supply.product.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PRD |
| Fixed Value | PRD |
| 25. Supply.product.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation, ImmunizationMedicationInformation) |
| Requirements | The product, if present, SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 26. Supply.author | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| Requirements | MAY contain zero or one [0..1] author (CONF:1098-7438). |
| 27. Supply.entryRelationship | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1) |
| 28. Supply.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444). |
| Pattern Value | SUBJ |
| 29. Supply.entryRelationship.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445). |
| Pattern Value | true |
| 30. Supply.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 31. Supply.entryRelationship.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 32. Supply.entryRelationship.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 33. Supply.entryRelationship.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 34. Supply.entryRelationship.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 35. Supply.entryRelationship.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 36. Supply.entryRelationship.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 37. Supply.entryRelationship.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 38. Supply.entryRelationship.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 39. Supply.entryRelationship.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(Instruction) |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
| 1. Supply | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| 2. Supply.classCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActClassSupply |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-7427). |
| Default Value | SPLY |
| Fixed Value | SPLY |
| 3. Supply.moodCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode="INT" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1098-7428). |
| Pattern Value | INT |
| 4. Supply.realmCode | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| 5. Supply.typeId | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| 6. Supply.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/fhir/cda/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Supply.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Supply.templateId:primary | |
| SliceName | 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/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain exactly one [1..1] templateId (CONF:1098-7429) such that it |
| 8. Supply.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 NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 9. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 10. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 11. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.17" (CONF:1098-10507). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.17 |
| 12. Supply.templateId:primary.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32578). |
| Pattern Value | 2014-06-09 |
| 13. Supply.id | |
| Control | 1..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/II |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-7430). |
| 14. Supply.code | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
| 15. Supply.text | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 16. Supply.statusCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-7432). |
| 17. Supply.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 NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 18. Supply.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 | 1..1 |
| Binding | The codes SHALL be taken from ActStatus |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code, which SHALL be selected from ValueSet ActStatus urn:oid:2.16.840.1.113883.1.11.15933 DYNAMIC (CONF:1098-32362). |
| 19. Supply.statusCode.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 20. Supply.statusCode.codeSystemName | |
| Definition | The common name of the coding system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 21. Supply.statusCode.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| Control | 0..0 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 22. Supply.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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 23. Supply.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 |
| XML Representation | 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 name valueSet. |
| 24. Supply.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 |
| XML Representation | 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 name valueSetVersion. |
| 25. Supply.statusCode.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
| 26. Supply.statusCode.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
| 27. Supply.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/fhir/cda/StructureDefinition/CD |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| 28. Supply.effectiveTime | |
| Control | 0..* |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS, http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Slicing | This element introduces a set of slices on Supply.effectiveTime. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 29. Supply.effectiveTime:when | |
| SliceName | when |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXCM-TS |
| XML Representation | The type of this property is determined using the xsi:type attribute. |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15143) such that it |
| 30. Supply.effectiveTime:when.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 NullFlavor |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 31. Supply.effectiveTime:when.value | |
| Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression. |
| Control | 0..1 |
| Type | dateTime |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 32. Supply.effectiveTime:when.inclusive | |
| Definition | Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open). |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 33. Supply.effectiveTime:when.operator | |
| Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point. |
| Control | 0..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 34. Supply.effectiveTime:when.low | |
| Definition | This is the low limit of the interval. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 35. Supply.effectiveTime:when.high | |
| Definition | This is the high limit of the interval. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| Requirements | SHALL contain exactly one [1..1] high (CONF:1098-15144). |
| 36. Supply.effectiveTime:when.width | |
| Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| 37. Supply.effectiveTime:when.center | |
| Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
| 38. Supply.priorityCode | |
| Control | 0..* |
| Binding | The codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 39. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| Requirements | SHOULD contain zero or one [0..1] repeatNumber (CONF:1098-7434). |
| 40. Supply.independentInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 41. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| Requirements | SHOULD contain zero or one [0..1] quantity (CONF:1098-7436). |
| 42. Supply.expectedUseTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 43. Supply.product | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-7439). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 44. Supply.product.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 45. Supply.product.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Supply.product.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 46. Supply.product.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetDirect |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | PRD |
| Fixed Value | PRD |
| 47. Supply.product.manufacturedProduct | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation, ImmunizationMedicationInformation) |
| Requirements | The product, if present, SHALL contain exactly one [1..1] Medication Information (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09) (CONF:1098-16093). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 48. Supply.subject | |
| Control | 0..1 |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 49. Supply.subject.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 50. Supply.subject.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Supply.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 51. Supply.subject.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationTargetSubject |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | SBJ |
| Fixed Value | SBJ |
| 52. Supply.subject.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 53. Supply.subject.awarenessCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 54. Supply.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 55. Supply.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 56. Supply.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| 57. Supply.author | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
| Requirements | MAY contain zero or one [0..1] author (CONF:1098-7438). |
| 58. Supply.informant | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 59. Supply.informant.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 60. Supply.informant.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Supply.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 61. Supply.informant.typeCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ParticipationInformationGenerator |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | INF |
| Fixed Value | INF |
| 62. Supply.informant.contextControlCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | OP |
| Fixed Value | OP |
| 63. Supply.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 64. Supply.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 65. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| 66. Supply.entryRelationship | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-7442). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) sup-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1) |
| 67. Supply.entryRelationship.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 68. Supply.entryRelationship.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Supply.entryRelationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 69. Supply.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @typeCode="SUBJ" (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-7444). |
| Pattern Value | SUBJ |
| 70. Supply.entryRelationship.inversionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1098-7445). |
| Pattern Value | true |
| 71. Supply.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 72. Supply.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 73. Supply.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 74. Supply.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 75. Supply.entryRelationship.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 76. Supply.entryRelationship.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 77. Supply.entryRelationship.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 78. Supply.entryRelationship.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 79. Supply.entryRelationship.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 80. Supply.entryRelationship.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 81. Supply.entryRelationship.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 82. Supply.entryRelationship.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 83. Supply.entryRelationship.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(Instruction) |
| Requirements | The entryRelationship, if present, SHALL contain exactly one [1..1] Instruction (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.20:2014-06-09) (CONF:1098-31391). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 84. Supply.reference | |
| Control | 0..* |
| Type | Element |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 85. Supply.reference.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 86. Supply.reference.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| 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. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Supply.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 87. Supply.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 88. Supply.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 89. Supply.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 90. Supply.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 91. Supply.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 92. Supply.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 93. Supply.precondition | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change