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.43 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-8577). |
| Pattern Value | PROC |
| 3. Supply.moodCode | |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply)For codes, see (unbound) |
| Requirements | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8578). |
| 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-30463) 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.43" (CONF:1098-30464). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.43 |
| 7. Supply.templateId:primary.extension | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32556). |
| Pattern Value | 2014-06-09 |
| 8. Supply.id | |
| Control | 10..* |
| Requirements | SHALL contain at least one [1..*] id (CONF:1098-8580). |
| 9. Supply.statusCode | |
| Control | 10..1 |
| Requirements | SHALL contain exactly one [1..1] statusCode (CONF:1098-30458). |
| 10. Supply.statusCode.code | |
| Control | 1..1 |
| Requirements | This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32047). |
| Pattern Value | active |
| 11. Supply.effectiveTime | |
| Control | 0..1* |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30459). |
| 12. Supply.repeatNumber | |
| Requirements | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32063). |
| 13. Supply.quantity | |
| Requirements | MAY contain zero or one [0..1] quantity (CONF:1098-32064). |
| 14. Supply.product | |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325). |
| Invariants | Defined on this element 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). (: null) |
| 15. Supply.product.manufacturedProduct | |
| Type | Choice of: (MedicationInformation), http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(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-32050). |
| 16. Supply.performer | |
| Requirements | MAY contain zero or more [0..*] performer (CONF:1098-32048). |
| 17. Supply.author | |
| Control | 0..1* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31129). |
| 18. Supply.participant | |
| Slicing | This element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 19. Supply.participant:productInstance | |
| SliceName | productInstance |
| Control | 0..1 |
| Requirements | MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it |
| Invariants | Defined on this element 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). (: null) |
| 20. Supply.participant:productInstance.participantRole | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance) |
| Requirements | SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095). |
| 21. Supply.entryRelationship | |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 22. Supply.entryRelationship:priorityPreference | |
| SliceName | priorityPreference |
| Control | 0..* |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31110) such that it |
| 23. Supply.entryRelationship:priorityPreference.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31111). |
| Pattern Value | REFR |
| 24. Supply.entryRelationship:priorityPreference.observation | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference) |
| Requirements | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31112). |
| 25. Supply.entryRelationship:indication | |
| SliceName | indication |
| Control | 0..* |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32054) such that it |
| 26. Supply.entryRelationship:indication.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32055). |
| Pattern Value | RSON |
| 27. Supply.entryRelationship:indication.observation | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(Indication) |
| Requirements | SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32056). |
| 28. Supply.entryRelationship:instruction | |
| SliceName | instruction |
| Control | 0..* |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32057) such that it |
| 29. Supply.entryRelationship:instruction.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32058). |
| Pattern Value | SUBJ |
| 30. Supply.entryRelationship:instruction.act | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(Instruction) |
| Requirements | 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-32059). |
| 31. Supply.entryRelationship:plannedCoverage | |
| SliceName | plannedCoverage |
| Control | 0..* |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32060) such that it |
| 32. Supply.entryRelationship:plannedCoverage.typeCode | |
| Control | 1..1 |
| Requirements | SHALL contain exactly one [1..1] @typeCode="COMP" Has Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32061). |
| Pattern Value | COMP |
| 33. Supply.entryRelationship:plannedCoverage.act | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(PlannedCoverage) |
| Requirements | SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062). |
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-8577). |
| Default Value | SPLY |
| Fixed Value | SPLY |
| Pattern Value | PROC |
| 3. Supply.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8578). |
| 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-30463) 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.43" (CONF:1098-30464). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.43 |
| 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-32556). |
| 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-8580). |
| 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-30458). |
| 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 |
| 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="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32047). |
| Pattern Value | active |
| 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..1 |
| 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. |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30459). |
| 19. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| Requirements | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32063). |
| 20. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| Requirements | MAY contain zero or one [0..1] quantity (CONF:1098-32064). |
| 21. Supply.product | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325). |
| Invariants | Defined on this element 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). (: null) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 22. 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 |
| 23. Supply.product.manufacturedProduct | |
| Control | 1..1 |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation), http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(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-32050). |
| 24. Supply.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| Requirements | MAY contain zero or more [0..*] performer (CONF:1098-32048). |
| 25. Supply.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31129). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 26. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Slicing | This element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 27. Supply.participant:productInstance | |
| SliceName | productInstance |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Requirements | MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it |
| Invariants | Defined on this element 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). (: null) |
| 28. Supply.participant:productInstance.participantRole | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance) |
| Requirements | SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 29. Supply.entryRelationship | |
| 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())) 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) |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 30. Supply.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 31. Supply.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 32. Supply.entryRelationship:priorityPreference | |
| SliceName | priorityPreference |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31110) such that it |
| 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) |
| 33. Supply.entryRelationship:priorityPreference.typeCode | |
| 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] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31111). |
| Pattern Value | REFR |
| 34. Supply.entryRelationship:priorityPreference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 35. Supply.entryRelationship:priorityPreference.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference) |
| Requirements | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31112). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 36. Supply.entryRelationship:priorityPreference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 37. Supply.entryRelationship:priorityPreference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 38. Supply.entryRelationship:priorityPreference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 39. Supply.entryRelationship:priorityPreference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 40. Supply.entryRelationship:priorityPreference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 41. Supply.entryRelationship:priorityPreference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 42. Supply.entryRelationship:priorityPreference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 43. Supply.entryRelationship:priorityPreference.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 44. Supply.entryRelationship:indication | |
| SliceName | indication |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32054) such that it |
| 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) |
| 45. Supply.entryRelationship:indication.typeCode | |
| 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] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32055). |
| Pattern Value | RSON |
| 46. Supply.entryRelationship:indication.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 47. Supply.entryRelationship:indication.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(Indication) |
| Requirements | SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32056). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 48. Supply.entryRelationship:indication.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 49. Supply.entryRelationship:indication.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 50. Supply.entryRelationship:indication.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 51. Supply.entryRelationship:indication.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 52. Supply.entryRelationship:indication.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 53. Supply.entryRelationship:indication.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 54. Supply.entryRelationship:indication.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 55. Supply.entryRelationship:indication.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 56. Supply.entryRelationship:instruction | |
| SliceName | instruction |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32057) such that it |
| 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) |
| 57. Supply.entryRelationship:instruction.typeCode | |
| 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] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32058). |
| Pattern Value | SUBJ |
| 58. Supply.entryRelationship:instruction.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 59. Supply.entryRelationship:instruction.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 60. Supply.entryRelationship:instruction.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 61. Supply.entryRelationship:instruction.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 62. Supply.entryRelationship:instruction.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 63. Supply.entryRelationship:instruction.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 64. Supply.entryRelationship:instruction.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 65. Supply.entryRelationship:instruction.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 66. Supply.entryRelationship:instruction.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 67. Supply.entryRelationship:instruction.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 | 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-32059). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 68. Supply.entryRelationship:plannedCoverage | |
| SliceName | plannedCoverage |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32060) such that it |
| 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) |
| 69. Supply.entryRelationship:plannedCoverage.typeCode | |
| 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] @typeCode="COMP" Has Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32061). |
| Pattern Value | COMP |
| 70. Supply.entryRelationship:plannedCoverage.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 71. Supply.entryRelationship:plannedCoverage.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 72. Supply.entryRelationship:plannedCoverage.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 73. Supply.entryRelationship:plannedCoverage.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 74. Supply.entryRelationship:plannedCoverage.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 75. Supply.entryRelationship:plannedCoverage.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 76. Supply.entryRelationship:plannedCoverage.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 77. Supply.entryRelationship:plannedCoverage.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 78. Supply.entryRelationship:plannedCoverage.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 79. Supply.entryRelationship:plannedCoverage.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(PlannedCoverage) |
| Requirements | SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062). |
| 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-8577). |
| Default Value | SPLY |
| Fixed Value | SPLY |
| Pattern Value | PROC |
| 3. Supply.moodCode | |
| Control | 1..1 |
| Binding | The codes SHALL be taken from Planned moodCode (SubstanceAdministration/Supply) |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Requirements | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2011-09-30 (CONF:1098-8578). |
| 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-30463) 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.43" (CONF:1098-30464). |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.43 |
| 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-32556). |
| 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-8580). |
| 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-30458). |
| 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 |
| 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="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32047). |
| Pattern Value | active |
| 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..1 |
| 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. |
| Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-30459). |
| 29. 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 |
| 30. Supply.repeatNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-INT |
| Requirements | MAY contain zero or one [0..1] repeatNumber (CONF:1098-32063). |
| 31. Supply.independentInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 32. Supply.quantity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/PQ |
| Requirements | MAY contain zero or one [0..1] quantity (CONF:1098-32064). |
| 33. Supply.expectedUseTime | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 34. Supply.product | |
| Control | 0..1 |
| Type | Element |
| Requirements | MAY contain zero or one [0..1] product (CONF:1098-32049 and CONF:1098-32051 and CONF:1098-32325). |
| Invariants | Defined on this element 1098-32092: If the product is Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) then the product **SHALL NOT** be Immunization Medication Information (2.16.840.1.113883.10.20.22.4.54.2) and the participant **SHALL NOT** be Product Instance (CONF:1098-32092). (: ) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 35. 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 |
| 36. 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:
|
| 37. 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 |
| 38. Supply.product.manufacturedProduct | |
| Control | 1..1 |
| Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(MedicationInformation), http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct(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-32050). |
| 39. 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())) |
| 40. 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 |
| 41. 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:
|
| 42. 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 |
| 43. 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 |
| 44. 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 |
| 45. Supply.subject.relatedSubject | |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
| 46. Supply.specimen | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
| 47. Supply.performer | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
| Requirements | MAY contain zero or more [0..*] performer (CONF:1098-32048). |
| 48. Supply.author | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation) |
| Requirements | SHOULD contain zero or one [0..1] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31129). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 49. 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())) |
| 50. 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 |
| 51. 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:
|
| 52. 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 |
| 53. 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 |
| 54. Supply.informant.assignedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
| 55. Supply.informant.relatedEntity | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
| 56. Supply.participant | |
| Control | 0..* |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Slicing | This element introduces a set of slices on Supply.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 57. Supply.participant:productInstance | |
| SliceName | productInstance |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
| Requirements | MAY contain zero or one [0..1] participant (CONF:1098-32094) such that it |
| Invariants | Defined on this element 1098-32096: If the participant is Product Instance then the product **SHALL NOT** be Medication Information (V2) (2.16.840.1.113883.10.20.22.4.23.2) and the product **SHALL NOT** be Immunization Medication Information (V2) (2.16.840.1.113883.10.20.22.4.54.2) (CONF:1098-32096). (: ) |
| 58. Supply.participant:productInstance.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. |
| 59. Supply.participant:productInstance.typeCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ParticipationType |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 60. Supply.participant:productInstance.contextControlCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ContextControl |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Fixed Value | OP |
| 61. Supply.participant:productInstance.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/fhir/cda/StructureDefinition/CS |
| 62. Supply.participant:productInstance.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/fhir/cda/StructureDefinition/II |
| 63. Supply.participant:productInstance.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 |
| 64. Supply.participant:productInstance.sdtcFunctionCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name functionCode. |
| 65. Supply.participant:productInstance.time | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
| 66. Supply.participant:productInstance.awarenessCode | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
| 67. Supply.participant:productInstance.participantRole | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole(ProductInstance) |
| Requirements | SHALL contain exactly one [1..1] Product Instance (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.37) (CONF:1098-32095). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 68. Supply.entryRelationship | |
| 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())) 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) |
| Slicing | This element introduces a set of slices on Supply.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 69. 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 |
| 70. 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:
|
| 71. Supply.entryRelationship.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 72. Supply.entryRelationship.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 73. Supply.entryRelationship.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 74. Supply.entryRelationship.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 75. Supply.entryRelationship.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 76. Supply.entryRelationship.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 77. Supply.entryRelationship.observation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 78. Supply.entryRelationship.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 79. Supply.entryRelationship.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 80. Supply.entryRelationship.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 81. Supply.entryRelationship.supply | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 82. Supply.entryRelationship.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 83. Supply.entryRelationship.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 84. Supply.entryRelationship.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 85. Supply.entryRelationship.act | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 86. Supply.entryRelationship:priorityPreference | |
| SliceName | priorityPreference |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-31110) such that it |
| 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) |
| 87. Supply.entryRelationship:priorityPreference.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 |
| 88. Supply.entryRelationship:priorityPreference.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:
|
| 89. Supply.entryRelationship:priorityPreference.typeCode | |
| 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] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-31111). |
| Pattern Value | REFR |
| 90. Supply.entryRelationship:priorityPreference.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 91. Supply.entryRelationship:priorityPreference.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 92. Supply.entryRelationship:priorityPreference.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 93. Supply.entryRelationship:priorityPreference.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 94. Supply.entryRelationship:priorityPreference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 95. Supply.entryRelationship:priorityPreference.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(PriorityPreference) |
| Requirements | SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-31112). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 96. Supply.entryRelationship:priorityPreference.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 97. Supply.entryRelationship:priorityPreference.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 98. Supply.entryRelationship:priorityPreference.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 99. Supply.entryRelationship:priorityPreference.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 100. Supply.entryRelationship:priorityPreference.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 101. Supply.entryRelationship:priorityPreference.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 102. Supply.entryRelationship:priorityPreference.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 103. Supply.entryRelationship:priorityPreference.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 104. Supply.entryRelationship:indication | |
| SliceName | indication |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32054) such that it |
| 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) |
| 105. Supply.entryRelationship:indication.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 |
| 106. Supply.entryRelationship:indication.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:
|
| 107. Supply.entryRelationship:indication.typeCode | |
| 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] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32055). |
| Pattern Value | RSON |
| 108. Supply.entryRelationship:indication.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 109. Supply.entryRelationship:indication.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 110. Supply.entryRelationship:indication.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 111. Supply.entryRelationship:indication.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 112. Supply.entryRelationship:indication.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 113. Supply.entryRelationship:indication.observation | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation(Indication) |
| Requirements | SHALL contain exactly one [1..1] Indication (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1098-32056). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 114. Supply.entryRelationship:indication.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 115. Supply.entryRelationship:indication.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 116. Supply.entryRelationship:indication.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 117. Supply.entryRelationship:indication.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 118. Supply.entryRelationship:indication.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 119. Supply.entryRelationship:indication.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 120. Supply.entryRelationship:indication.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 121. Supply.entryRelationship:indication.act | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
| 122. Supply.entryRelationship:instruction | |
| SliceName | instruction |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32057) such that it |
| 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) |
| 123. Supply.entryRelationship:instruction.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 |
| 124. Supply.entryRelationship:instruction.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:
|
| 125. Supply.entryRelationship:instruction.typeCode | |
| 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] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32058). |
| Pattern Value | SUBJ |
| 126. Supply.entryRelationship:instruction.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 127. Supply.entryRelationship:instruction.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 128. Supply.entryRelationship:instruction.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 129. Supply.entryRelationship:instruction.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 130. Supply.entryRelationship:instruction.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 131. Supply.entryRelationship:instruction.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 132. Supply.entryRelationship:instruction.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 133. Supply.entryRelationship:instruction.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 134. Supply.entryRelationship:instruction.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 135. Supply.entryRelationship:instruction.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 136. Supply.entryRelationship:instruction.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 137. Supply.entryRelationship:instruction.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 138. Supply.entryRelationship:instruction.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 139. Supply.entryRelationship:instruction.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 | 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-32059). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 140. Supply.entryRelationship:plannedCoverage | |
| SliceName | plannedCoverage |
| Control | 0..* |
| Type | Element |
| Requirements | MAY contain zero or more [0..*] entryRelationship (CONF:1098-32060) such that it |
| 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) |
| 141. Supply.entryRelationship:plannedCoverage.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 |
| 142. Supply.entryRelationship:plannedCoverage.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:
|
| 143. Supply.entryRelationship:plannedCoverage.typeCode | |
| 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] @typeCode="COMP" Has Component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32061). |
| Pattern Value | COMP |
| 144. Supply.entryRelationship:plannedCoverage.inversionInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 145. Supply.entryRelationship:plannedCoverage.contextConductionInd | |
| Control | 1..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Default Value | true |
| 146. Supply.entryRelationship:plannedCoverage.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
| 147. Supply.entryRelationship:plannedCoverage.negationInd | |
| Control | 0..1 |
| Type | boolean |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 148. Supply.entryRelationship:plannedCoverage.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 149. Supply.entryRelationship:plannedCoverage.observation | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
| 150. Supply.entryRelationship:plannedCoverage.regionOfInterest | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
| 151. Supply.entryRelationship:plannedCoverage.observationMedia | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
| 152. Supply.entryRelationship:plannedCoverage.substanceAdministration | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
| 153. Supply.entryRelationship:plannedCoverage.supply | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
| 154. Supply.entryRelationship:plannedCoverage.procedure | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
| 155. Supply.entryRelationship:plannedCoverage.encounter | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
| 156. Supply.entryRelationship:plannedCoverage.organizer | |
| Control | 0..0 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
| 157. Supply.entryRelationship:plannedCoverage.act | |
| Definition | Base definition for all types defined in FHIR type system. |
| Control | 1..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/Act(PlannedCoverage) |
| Requirements | SHALL contain exactly one [1..1] Planned Coverage (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.129) (CONF:1098-32062). |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 158. 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())) |
| 159. 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 |
| 160. 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:
|
| 161. Supply.reference.typeCode | |
| Control | 1..1 |
| Type | code |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 162. Supply.reference.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
| 163. Supply.reference.externalAct | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
| 164. Supply.reference.externalObservation | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
| 165. Supply.reference.externalProcedure | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
| 166. Supply.reference.externalDocument | |
| Control | 0..1 |
| Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
| 167. 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