This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicalEquipmentSection | Version: 3.0.0-ballot | |||
Draft as of 2023-12-21 | 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 template. Equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs) is represented by the Non-Medicinal Supply Activity 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-non-med-supply: SHOULD contain Non-Medicinal Supply Activity should-procedure-act-procedure: SHOULD contain Procedure Activity Procedure |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.23 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
code | 1..1 | CE | Medical Equipment | |
@code | 1..1 | cs | Required Pattern: 46264-8 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
entry:medicalEquip | 0..* | Entry | ||
organizer | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources | |
entry:nonMedSupply | 0..* | Entry | ||
supply | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources | |
entry:procedure | 0..* | Entry | ||
procedure | 1..1 | ProcedureActivityProcedure | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-non-med-supply: SHOULD contain Non-Medicinal Supply Activity should-procedure-act-procedure: SHOULD contain Procedure Activity Procedure |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.23 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
code | 1..1 | CE | Medical Equipment Binding: DocumentSectionType (example) | |
@code | 1..1 | cs | Required Pattern: 46264-8 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
entry:medicalEquip | 0..* | Entry | ||
organizer | C | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources |
entry:nonMedSupply | 0..* | Entry | ||
supply | C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources |
entry:procedure | 0..* | Entry | ||
procedure | C | 1..1 | ProcedureActivityProcedure | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet |
Section.code | example | DocumentSectionType |
Id | Grade | Path(s) | Details | Requirements |
1098-32380 | error | Section.entry:medicalEquip.organizer | Either Non-Medicinal Supply Activity (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380). : component.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')).exists() or component.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')).exists() | |
active-high-ts-after-document | error | Section.entry:procedure.procedure | If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime : (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value | |
should-author | warning | Section.entry:procedure.procedure | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-performer | warning | Section.entry:procedure.procedure | SHOULD contain performer : performer.exists() | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) | |
should-quantity | warning | Section.entry:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-sdtctext-ref-value | warning | Section.entry:medicalEquip.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
should-targetSiteCode | warning | Section.entry:procedure.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
should-text-ref-value | warning | Section.entry:nonMedSupply.supply, Section.entry:procedure.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() |
Path | Conformance | ValueSet / Code |
Section.nullFlavor | required | CDANullFlavor |
Section.typeId.nullFlavor | required | CDANullFlavor |
Section.templateId:section.nullFlavor | required | CDANullFlavor |
Section.classCode | required | Fixed Value: DOCSECT |
Section.moodCode | required | Fixed Value: EVN |
Section.code | example | DocumentSectionType |
Section.code.nullFlavor | required | CDANullFlavor |
Section.languageCode | required | AllLanguages |
Section.entry:medicalEquip.nullFlavor | required | CDANullFlavor |
Section.entry:medicalEquip.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:medicalEquip.typeCode | required | XActRelationshipEntry |
Section.entry:nonMedSupply.nullFlavor | required | CDANullFlavor |
Section.entry:nonMedSupply.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:nonMedSupply.typeCode | required | XActRelationshipEntry |
Section.entry:procedure.nullFlavor | required | CDANullFlavor |
Section.entry:procedure.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:procedure.typeCode | required | XActRelationshipEntry |
Section.component.nullFlavor | required | CDANullFlavor |
Section.component.typeId.nullFlavor | required | CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
1098-32380 | error | Section.entry:medicalEquip.organizer | Either Non-Medicinal Supply Activity (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380). : component.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')).exists() or component.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')).exists() | |
active-high-ts-after-document | error | Section.entry:procedure.procedure | If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime : (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value | |
should-author | warning | Section.entry:procedure.procedure | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-performer | warning | Section.entry:procedure.procedure | SHOULD contain performer : performer.exists() | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) | |
should-quantity | warning | Section.entry:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-sdtctext-ref-value | warning | Section.entry:medicalEquip.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
should-targetSiteCode | warning | Section.entry:procedure.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
should-text-ref-value | warning | Section.entry:nonMedSupply.supply, Section.entry:procedure.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-non-med-supply: SHOULD contain Non-Medicinal Supply Activity should-procedure-act-procedure: SHOULD contain Procedure Activity Procedure |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.23 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
code | 1..1 | CE | Medical Equipment | |
@code | 1..1 | cs | Required Pattern: 46264-8 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
entry:medicalEquip | 0..* | Entry | ||
organizer | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources | |
entry:nonMedSupply | 0..* | Entry | ||
supply | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources | |
entry:procedure | 0..* | Entry | ||
procedure | 1..1 | ProcedureActivityProcedure | Base for all types and resources | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | C | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-non-med-supply: SHOULD contain Non-Medicinal Supply Activity should-procedure-act-procedure: SHOULD contain Procedure Activity Procedure |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:section | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.2.23 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
code | 1..1 | CE | Medical Equipment Binding: DocumentSectionType (example) | |
@code | 1..1 | cs | Required Pattern: 46264-8 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
title | 1..1 | ST | ||
text | 1..1 | xhtml | ||
Slices for entry | 0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
entry:medicalEquip | 0..* | Entry | ||
organizer | C | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources |
entry:nonMedSupply | 0..* | Entry | ||
supply | C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources |
entry:procedure | 0..* | Entry | ||
procedure | C | 1..1 | ProcedureActivityProcedure | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet |
Section.code | example | DocumentSectionType |
Id | Grade | Path(s) | Details | Requirements |
1098-32380 | error | Section.entry:medicalEquip.organizer | Either Non-Medicinal Supply Activity (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380). : component.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')).exists() or component.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')).exists() | |
active-high-ts-after-document | error | Section.entry:procedure.procedure | If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime : (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value | |
should-author | warning | Section.entry:procedure.procedure | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-performer | warning | Section.entry:procedure.procedure | SHOULD contain performer : performer.exists() | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) | |
should-quantity | warning | Section.entry:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-sdtctext-ref-value | warning | Section.entry:medicalEquip.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
should-targetSiteCode | warning | Section.entry:procedure.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
should-text-ref-value | warning | Section.entry:nonMedSupply.supply, Section.entry:procedure.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() |
Snapshot View
Path | Conformance | ValueSet / Code |
Section.nullFlavor | required | CDANullFlavor |
Section.typeId.nullFlavor | required | CDANullFlavor |
Section.templateId:section.nullFlavor | required | CDANullFlavor |
Section.classCode | required | Fixed Value: DOCSECT |
Section.moodCode | required | Fixed Value: EVN |
Section.code | example | DocumentSectionType |
Section.code.nullFlavor | required | CDANullFlavor |
Section.languageCode | required | AllLanguages |
Section.entry:medicalEquip.nullFlavor | required | CDANullFlavor |
Section.entry:medicalEquip.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:medicalEquip.typeCode | required | XActRelationshipEntry |
Section.entry:nonMedSupply.nullFlavor | required | CDANullFlavor |
Section.entry:nonMedSupply.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:nonMedSupply.typeCode | required | XActRelationshipEntry |
Section.entry:procedure.nullFlavor | required | CDANullFlavor |
Section.entry:procedure.typeId.nullFlavor | required | CDANullFlavor |
Section.entry:procedure.typeCode | required | XActRelationshipEntry |
Section.component.nullFlavor | required | CDANullFlavor |
Section.component.typeId.nullFlavor | required | CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
1098-32380 | error | Section.entry:medicalEquip.organizer | Either Non-Medicinal Supply Activity (templateId:2.16.840.1.113883.10.20.22.4.50:2014-06-09) **OR** Procedure Activity Procedure (templateId:2.16.840.1.113883.10.20.22.4.14:2014-06-09) **SHALL** be present (CONF:1098-32380). : component.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')).exists() or component.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')).exists() | |
active-high-ts-after-document | error | Section.entry:procedure.procedure | If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime : (statusCode.code = 'active' and effectiveTime.high.value.exists()) implies effectiveTime.high.value > %resource.effectiveTime.value | |
should-author | warning | Section.entry:procedure.procedure | SHOULD contain author : author.exists() | |
should-effectiveTime | warning | Section.entry:nonMedSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
should-non-med-supply | warning | Section | SHOULD contain Non-Medicinal Supply Activity : entry.where(supply.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity')) | |
should-performer | warning | Section.entry:procedure.procedure | SHOULD contain performer : performer.exists() | |
should-procedure-act-procedure | warning | Section | SHOULD contain Procedure Activity Procedure : entry.where(procedure.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ProcedureActivityProcedure')) | |
should-quantity | warning | Section.entry:nonMedSupply.supply | SHOULD contain quantity : quantity.exists() | |
should-sdtctext-ref-value | warning | Section.entry:medicalEquip.organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
should-targetSiteCode | warning | Section.entry:procedure.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
should-text-ref-value | warning | Section.entry:nonMedSupply.supply, Section.entry:procedure.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() |
This structure is derived from Section
Summary
Mandatory: 9 elements (3 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: