Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicalEquipmentSection | Version: 4.0.0-ballot | |||
| Draft as of 2024-11-21 | Computable Name: MedicalEquipmentSection | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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 Template, 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 Instance 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 | History of medical device use | |
 @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 Instance 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 | History of medical device use 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 should-sdtctext-ref-value: SHOULD contain text/reference/@value 1098-32380: 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). |
| entry:nonMedSupply |
0..* | Entry | ||
| supply |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
| entry:procedure |
0..* | Entry | ||
| procedure |
C | 1..1 | ProcedureActivityProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-performer: SHOULD contain performer should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-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() |
| 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 Instance 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 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @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 | |
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
1..1 | CE | History of medical device use Binding: DocumentSectionType (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 46264-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
| entry:medicalEquip |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
C | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources should-sdtctext-ref-value: SHOULD contain text/reference/@value 1098-32380: 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). |
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| entry:nonMedSupply |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
| entry:procedure |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
C | 1..1 | ProcedureActivityProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-performer: SHOULD contain performer should-author: SHOULD contain author |
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| component |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Section.entry:medicalEquip.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medicalEquip.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medicalEquip.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.entry:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:nonMedSupply.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.entry:procedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:procedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:procedure.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/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 Instance 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 | History of medical device use | |
| @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 Instance 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 | History of medical device use 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 should-sdtctext-ref-value: SHOULD contain text/reference/@value 1098-32380: 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). |
| entry:nonMedSupply |
0..* | Entry | ||
| supply |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
| entry:procedure |
0..* | Entry | ||
| procedure |
C | 1..1 | ProcedureActivityProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-performer: SHOULD contain performer should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-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
| 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 Instance 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 |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:section |
1..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @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 | |
| @ID |
0..1 | xs:ID | ||
| @classCode |
0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
| @moodCode |
0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
0..1 | II | ||
| code |
1..1 | CE | History of medical device use Binding: DocumentSectionType (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 46264-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| translation |
0..* | CD | ||
| title |
1..1 | ST | ||
| text |
1..1 | xhtml | ||
| confidentialityCode |
0..1 | CE | ||
| languageCode |
0..1 | CS | Binding: AllLanguages (required) | |
| subject |
0..1 | Subject | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| Slices for entry |
0..* | Entry | Slice: Unordered, Open by profile:organizer, profile:procedure, profile:supply | |
| entry:medicalEquip |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
C | 1..1 | MedicalEquipmentOrganizer | Base for all types and resources should-sdtctext-ref-value: SHOULD contain text/reference/@value 1098-32380: 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). |
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| entry:nonMedSupply |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
C | 1..1 | NonMedicinalSupplyActivity | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-quantity: SHOULD contain quantity |
| entry:procedure |
0..* | Entry | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: x_ActRelationshipEntry (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
C | 1..1 | ProcedureActivityProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value active-high-ts-after-document: If the procedure is active and contains a high effectiveTime, this time SHALL be after the ClinicalDocument/effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode should-performer: SHOULD contain performer should-author: SHOULD contain author |
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| component |
0..* | InfrastructureRoot | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Fixed Value: COMP | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| section |
1..1 | Section | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.templateId:section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
| Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
| Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languagesfrom the FHIR Standard | |
| Section.entry:medicalEquip.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medicalEquip.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:medicalEquip.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.entry:nonMedSupply.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:nonMedSupply.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:nonMedSupply.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.entry:procedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:procedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.entry:procedure.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
| Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/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:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change