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

Resource Profile: Medical Equipment Section

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.2.23 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: MedicalEquipmentSection
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.2.23:2014-06-09

This section defines a patient’s implanted and external health and medical devices and equipment. This section lists any pertinent durable medical equipment (DME) used to help maintain the patient’s health status. All equipment relevant to the diagnosis, care, or treatment of a patient should be included.

Devices applied to, or placed in, the patient are represented with the Procedure Activity Procedure (V2) template. Equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs) is represented by the Non-Medicinal Supply Activity V2 template.

These devices may be grouped together within a Medical Equipment Organizer. The organizer would probably not be used with devices applied in or on the patient but rather to organize a group of medical supplies the patient has been supplied with.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CE
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... Slices for entry 0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:medicalEquip 0..*Element
..... organizer 1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply 0..*Element
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure 0..*Element
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... text S1..1xhtml
... Slices for entry C0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entry:medicalEquip C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer C1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorSection.entry:medicalEquip.organizerEither Non-Medicinal Supply Activity (V2) (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (V2) (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entry, Section.entry:medicalEquip, Section.entry:nonMedSupply, Section.entry:procedureSHALL 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry C0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entry:medicalEquip C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer C1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredNullFlavor
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorSection.entry:medicalEquip.organizerEither Non-Medicinal Supply Activity (V2) (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (V2) (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entry, Section.entry:medicalEquip, Section.entry:nonMedSupply, Section.entry:procedureSHALL 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

This structure is derived from CDAR2.Section

Summary

Mandatory: 8 elements (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension
  • The element Section.entry is sliced based on the values of profile:organizer, profile:procedure, profile:supply

Differential View

This structure is derived from CDAR2.Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... code 1..1CE
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... Slices for entry 0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:medicalEquip 0..*Element
..... organizer 1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply 0..*Element
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure 0..*Element
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
... title 1..1ED
... text S1..1xhtml
... Slices for entry C0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entry:medicalEquip C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer C1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure C0..*Element
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorSection.entry:medicalEquip.organizerEither Non-Medicinal Supply Activity (V2) (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (V2) (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entry, Section.entry:medicalEquip, Section.entry:nonMedSupply, Section.entry:procedureSHALL 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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section 1..1CDAR2.SectionBase for all types and resources
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.2.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 46264-8
.... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.6.1
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 1..1ED
... text S1..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for entry C0..*ElementSlice: Unordered, Open by profile:organizer, profile:procedure, profile:supply
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entry:medicalEquip C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... organizer C1..1MedicalEquipmentOrganizerBase for all types and resources
.... entry:nonMedSupply C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... supply 1..1NonMedicinalSupplyActivityBase for all types and resources
.... entry:procedure C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
..... procedure 1..1ProcedureActivityProcedureBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredNullFlavor
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorSection.entry:medicalEquip.organizerEither Non-Medicinal Supply Activity (V2) (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (V2) (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entry, Section.entry:medicalEquip, Section.entry:nonMedSupply, Section.entry:procedureSHALL 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

This structure is derived from CDAR2.Section

Summary

Mandatory: 8 elements (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the values of value:root, value:extension
  • The element Section.entry is sliced based on the values of profile:organizer, profile:procedure, profile:supply

 

​Other representations of profile: CSV, Excel, Schematron