Consolidated CDA Release 2.2
2.2 - CI Build

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

Resource Profile: MedicationsSectionEntriesRequired - Detailed Descriptions

Definitions for the 2.16.840.1.113883.10.20.22.2.1.1 resource profile.

1. Section
Control1..1
2. Section.ID
Control0..1
Typestring
3. Section.nullFlavor
Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
Requirements

MAY contain zero or one [0..1] @nullFlavor="NI" No information (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1098-32845).

Pattern ValueNI
4. Section.classCode
Control1..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ActClassOrganizer
Typecode
Default ValueDOCSECT
Fixed ValueDOCSECT
5. Section.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
Typecode
Default ValueEVN
Fixed ValueEVN
6. Section.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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Section.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
7. Section.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7791) such that it

8. Section.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
9. Section.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.

Control0..1
Typestring
10. Section.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).

Control0..1
Typeboolean
11. Section.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.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.2.1" (CONF:1098-10432).

Pattern Value2.16.840.1.113883.10.20.22.2.1
12. Section.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32500).

Pattern Value2014-06-09
13. Section.templateId:secondary
SliceNamesecondary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-7568) such that it

14. Section.templateId:secondary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
15. Section.templateId:secondary.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.

Control0..1
Typestring
16. Section.templateId:secondary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
17. Section.templateId:secondary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.2.1.1" (CONF:1098-10433).

Pattern Value2.16.840.1.113883.10.20.22.2.1.1
18. Section.templateId:secondary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32499).

Pattern Value2014-06-09
19. Section.id
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
20. Section.code
Control1..1
BindingThe codes SHALL be taken from DocumentSectionType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

SHALL contain exactly one [1..1] code (CONF:1098-15387).

21. Section.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
22. Section.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @code="10160-0" History of medication use (CONF:1098-15388).

Pattern Value10160-0
23. Section.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.1" (CodeSystem: LOINC urn:oid:2.16.840.1.113883.6.1) (CONF:1098-30825).

Pattern Value2.16.840.1.113883.6.1
24. Section.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
25. Section.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
26. Section.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
27. Section.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
28. Section.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
29. Section.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
30. Section.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
31. Section.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
32. Section.title
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

SHALL contain exactly one [1..1] title (CONF:1098-7570).

33. Section.text
Control1..1
Typexhtml
Must Supporttrue
Requirements

SHALL contain exactly one [1..1] text (CONF:1098-7571).

34. Section.confidentialityCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
35. Section.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
36. Section.subject
Control0..1
TypeElement
37. Section.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
38. Section.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
39. Section.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
40. Section.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
41. Section.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
42. Section.informant
Control0..*
TypeElement
43. Section.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
44. Section.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
45. Section.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
46. Section.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
47. Section.entry
Control1..*
TypeElement
InvariantsDefined on this element
only-one-statement: SHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act. (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ substanceAdministration
48. Section.entry:medActivity
SliceNamemedActivity
Control1..*
TypeElement
Requirements

SHALL contain at least one [1..*] entry (CONF:1098-7572) such that it

InvariantsDefined on this element
only-one-statement: SHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act. (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
49. Section.entry:medActivity.typeCode
Control1..1
Typecode
Default ValueCOMP
50. Section.entry:medActivity.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
51. Section.entry:medActivity.observation
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
52. Section.entry:medActivity.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
53. Section.entry:medActivity.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
54. Section.entry:medActivity.substanceAdministration
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration(MedicationActivity)
Requirements

SHALL contain exactly one [1..1] Medication Activity (V2) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.16:2014-06-09) (CONF:1098-10076).

InvariantsDefined on this element
1098-30800: Medication Activity **SHOULD** include doseQuantity **OR** rateQuantity (CONF:1098-30800). (: )
55. Section.entry:medActivity.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
56. Section.entry:medActivity.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
57. Section.entry:medActivity.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
58. Section.entry:medActivity.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
59. Section.entry:medActivity.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
60. Section.component
Control0..*
TypeElement
61. Section.component.typeCode
Definition

Drawn from concept domain DocumentSectionType

Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
62. Section.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
63. Section.component.section
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Section