Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Active as of 2022-05-13 |
Definitions for the 2.16.840.1.113883.10.20.22.4.50 resource profile.
1. Supply | |
Control | 1..1 |
2. Supply.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActClassSupply |
Type | code |
Requirements | SHALL contain exactly one [1..1] @classCode="SPLY" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1098-8745). |
Default Value | SPLY |
Fixed Value | SPLY |
Pattern Value | SPLY |
3. Supply.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from MoodCodeEvnInt |
Type | code |
Requirements | SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet MoodCodeEvnInt urn:oid:2.16.840.1.113883.11.20.9.18 STATIC 2011-04-03 (CONF:1098-8746). |
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-8747) 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 |
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 |
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 |
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 |
Requirements | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.50" (CONF:1098-10509). |
Pattern Value | 2.16.840.1.113883.10.20.22.4.50 |
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 |
Requirements | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32514). |
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-8748). |
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-8749). |
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 |
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 |
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-32363). |
19. Supply.statusCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
20. Supply.statusCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
21. Supply.statusCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
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 |
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 |
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 |
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 |
28. Supply.effectiveTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS |
Requirements | SHOULD contain zero or one [0..1] effectiveTime (CONF:1098-15498). |
Invariants | Defined on this element 1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867). (: ) |
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 |
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 | SHOULD contain zero or one [0..1] quantity (CONF:1098-8751). |
33. Supply.expectedUseTime | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
34. Supply.product | |
Control | 0..1 |
Type | Element |
35. Supply.product.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationTargetDirect |
Type | code |
Default Value | PRD |
Fixed Value | PRD |
36. Supply.product.manufacturedProduct | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ManufacturedProduct |
37. Supply.subject | |
Control | 0..1 |
Type | Element |
38. Supply.subject.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationTargetSubject |
Type | code |
Default Value | SBJ |
Fixed Value | SBJ |
39. Supply.subject.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
40. 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 |
41. Supply.subject.relatedSubject | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedSubject |
42. Supply.specimen | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Specimen |
43. Supply.performer | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Performer2 |
44. Supply.author | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Author |
45. Supply.informant | |
Control | 0..* |
Type | Element |
46. Supply.informant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationInformationGenerator |
Type | code |
Default Value | INF |
Fixed Value | INF |
47. Supply.informant.contextControlCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Default Value | OP |
Fixed Value | OP |
48. Supply.informant.assignedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
49. Supply.informant.relatedEntity | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RelatedEntity |
50. 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:
|
51. Supply.participant:participant1 | |
SliceName | participant1 |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Participant2 |
Requirements | MAY contain zero or one [0..1] participant (CONF:1098-8752) such that it |
52. Supply.participant:participant1.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 |
53. Supply.participant:participant1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
Requirements | SHALL contain exactly one [1..1] @typeCode="PRD" Product (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1098-8754). |
Pattern Value | PRD |
54. Supply.participant:participant1.contextControlCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
Fixed Value | OP |
55. Supply.participant:participant1.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 |
56. Supply.participant:participant1.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 |
57. Supply.participant:participant1.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 |
58. Supply.participant:participant1.sdtcFunctionCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
59. Supply.participant:participant1.time | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
60. Supply.participant:participant1.awarenessCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
61. Supply.participant:participant1.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-15900). |
62. Supply.entryRelationship | |
Control | 0..* |
Type | Element |
Invariants | Defined on this element 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:
|
63. Supply.entryRelationship.typeCode | |
Control | 1..1 |
Type | code |
64. Supply.entryRelationship.inversionInd | |
Control | 0..1 |
Type | boolean |
65. Supply.entryRelationship.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
66. Supply.entryRelationship.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
67. Supply.entryRelationship.negationInd | |
Control | 0..1 |
Type | boolean |
68. Supply.entryRelationship.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
69. Supply.entryRelationship.observation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
70. Supply.entryRelationship.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
71. Supply.entryRelationship.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
72. Supply.entryRelationship.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
73. Supply.entryRelationship.supply | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
74. Supply.entryRelationship.procedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
75. Supply.entryRelationship.encounter | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
76. Supply.entryRelationship.organizer | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
77. Supply.entryRelationship.act | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Act |
78. Supply.entryRelationship:instruction | |
SliceName | instruction |
Control | 0..1 |
Type | Element |
Requirements | MAY contain zero or one [0..1] entryRelationship (CONF:1098-30277) such that it |
Invariants | Defined on this element 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) |
79. Supply.entryRelationship:instruction.typeCode | |
Control | 1..1 |
Type | code |
Requirements | SHALL contain exactly one [1..1] @typeCode="SUBJ" (CONF:1098-30278). |
Pattern Value | SUBJ |
80. Supply.entryRelationship:instruction.inversionInd | |
Control | 1..1 |
Type | boolean |
Requirements | SHALL contain exactly one [1..1] @inversionInd="true" (CONF:1098-30279). |
Pattern Value | true |
81. Supply.entryRelationship:instruction.contextConductionInd | |
Control | 1..1 |
Type | boolean |
Default Value | true |
82. Supply.entryRelationship:instruction.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/INT |
83. Supply.entryRelationship:instruction.negationInd | |
Control | 0..1 |
Type | boolean |
84. Supply.entryRelationship:instruction.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
85. Supply.entryRelationship:instruction.observation | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Observation |
86. Supply.entryRelationship:instruction.regionOfInterest | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest |
87. Supply.entryRelationship:instruction.observationMedia | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ObservationMedia |
88. Supply.entryRelationship:instruction.substanceAdministration | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration |
89. Supply.entryRelationship:instruction.supply | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Supply |
90. Supply.entryRelationship:instruction.procedure | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Procedure |
91. Supply.entryRelationship:instruction.encounter | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Encounter |
92. Supply.entryRelationship:instruction.organizer | |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organizer |
93. 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-31393). |
94. Supply.reference | |
Control | 0..* |
Type | Element |
95. Supply.reference.typeCode | |
Control | 1..1 |
Type | code |
96. Supply.reference.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/BL |
97. Supply.reference.externalAct | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalAct |
98. Supply.reference.externalObservation | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalObservation |
99. Supply.reference.externalProcedure | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure |
100. Supply.reference.externalDocument | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ExternalDocument |
101. Supply.precondition | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/Precondition |