Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 United States of America flag

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

Logical Model: Medical Equipment Organizer

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicalEquipmentOrganizer Version: 4.0.0-ballot
Draft as of 2024-11-21 Computable Name: MedicalEquipmentOrganizer
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.135

This template represents a set of current or historical medical devices, supplies, aids and equipment used by the patient. Examples are hearing aids, orthotic devices, ostomy supplies, visual aids, diabetic supplies such as syringes and pumps, and wheelchairs.

Devices that are applied during a procedure (e.g., cardiac pacemaker, gastrosomy tube, port catheter), whether permanent or temporary, are represented within the Procedure Activity Procedure template (templateId: 2.16.840.1.113883.10.20.22.4.14.2).

Usage:

Formal Views of Template Content

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

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:medical-equipment-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.135
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: CLUSTER
... @moodCode 1..1 cs
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
... sdtcText 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
.... @nullFlavor 0..0
.... @code 1..1 cs Binding: Result Status . (required)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... low 1..1 IVXB_TS
.... high 1..1 IVXB_TS
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... supply 1..1 NonMedicinalSupplyActivity Base for all types and resources
.... component:procedureActivity 0..* OrganizerComponent
..... procedure 1..1 ProcedureActivityProcedure Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:medical-equipment-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.135
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
Binding: ActStatus (required)
.... @code 1..1 cs Binding: Result Status . (required)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... low 1..1 IVXB_TS
.... high 1..1 IVXB_TS
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... 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
.... component:procedureActivity 0..* OrganizerComponent
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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-documenterrorOrganizer.component:procedureActivity.procedureIf 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-authorwarningOrganizer.component:procedureActivity.procedureSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:nonMedicalSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningOrganizer.component:procedureActivity.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningOrganizer.component:nonMedicalSupply.supplySHOULD contain quantity
: quantity.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:procedureActivity.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... @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:medical-equipment-org 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.4.135
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
Binding: ActStatus (required)
.... @code 1..1 cs Binding: Result Status . (required)
.... @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)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 1..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 1..1 IVXB_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... 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
.... component:procedureActivity 0..* OrganizerComponent
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:medical-equipment-org.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.sdtcText.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.sdtcText.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Organizer.sdtcText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Organizer.sdtcText.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Organizer.sdtcText.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Organizer.component:nonMedicalSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:nonMedicalSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:nonMedicalSupply.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:procedureActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:procedureActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:procedureActivity.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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-documenterrorOrganizer.component:procedureActivity.procedureIf 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-authorwarningOrganizer.component:procedureActivity.procedureSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:nonMedicalSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningOrganizer.component:procedureActivity.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningOrganizer.component:nonMedicalSupply.supplySHOULD contain quantity
: quantity.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:procedureActivity.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Organizer

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organizer.templateId
  • The element 2 is sliced based on the values of Organizer.component

Differential View

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:medical-equipment-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.135
..... @extension 0..0
... @classCode 1..1 cs Fixed Value: CLUSTER
... @moodCode 1..1 cs
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
... sdtcText 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
.... @nullFlavor 0..0
.... @code 1..1 cs Binding: Result Status . (required)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... low 1..1 IVXB_TS
.... high 1..1 IVXB_TS
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... supply 1..1 NonMedicinalSupplyActivity Base for all types and resources
.... component:procedureActivity 0..* OrganizerComponent
..... procedure 1..1 ProcedureActivityProcedure Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... Slices for templateId 1..* II Slice: Unordered, Open by value:root
.... templateId:medical-equipment-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.135
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
Binding: ActStatus (required)
.... @code 1..1 cs Binding: Result Status . (required)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... low 1..1 IVXB_TS
.... high 1..1 IVXB_TS
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... 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
.... component:procedureActivity 0..* OrganizerComponent
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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-documenterrorOrganizer.component:procedureActivity.procedureIf 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-authorwarningOrganizer.component:procedureActivity.procedureSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:nonMedicalSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningOrganizer.component:procedureActivity.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningOrganizer.component:nonMedicalSupply.supplySHOULD contain quantity
: quantity.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:procedureActivity.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C 1..1 Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
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).
... @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:medical-equipment-org 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.4.135
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 1..* II
... sdtcCategory 0..* CD XML Namespace: urn:hl7-org:sdtc
XML: category (urn:hl7-org:sdtc)
... code 0..1 CD This code can represent a category of devices. The code is strictly optional, and is not currently limited to any value set or code system. Implementers may use it if they wish to provide optional coded information about this grouping of medical equipment.
Binding: v3 Code System ActCode (example)
... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS The organizer is a collection of statuses for contained entries. The organizer remains active until all contained entries are done.
Binding: ActStatus (required)
.... @code 1..1 cs Binding: Result Status . (required)
.... @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)
... effectiveTime 1..1 IVL_TS The effectiveTime can be used to show the time period over which the patient will be using the set of equipment. The organizer would probably not be used with devices applied in or on the patient.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 1..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 1..1 IVXB_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 0..* OrganizerComponent Slice: Unordered, Open by profile:supply, profile:procedure
.... component:nonMedicalSupply 0..* OrganizerComponent
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... 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
.... component:procedureActivity 0..* OrganizerComponent
..... @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: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1 bl Fixed Value: true
..... sequenceNumber 0..1 INT
..... sdtcPriorityNumber 0..1 INT XML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1 BL
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:medical-equipment-org.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredFixed Value: CLUSTER
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.sdtcText.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.sdtcText.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Organizer.sdtcText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Organizer.sdtcText.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Organizer.sdtcText.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResultStatus .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator
Organizer.component:nonMedicalSupply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:nonMedicalSupply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:nonMedicalSupply.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:procedureActivity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:procedureActivity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:procedureActivity.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
1098-32380errorOrganizerEither 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-documenterrorOrganizer.component:procedureActivity.procedureIf 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-authorwarningOrganizer.component:procedureActivity.procedureSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:nonMedicalSupply.supplySHOULD contain effectiveTime
: effectiveTime.exists()
should-performerwarningOrganizer.component:procedureActivity.procedureSHOULD contain performer
: performer.exists()
should-quantitywarningOrganizer.component:nonMedicalSupply.supplySHOULD contain quantity
: quantity.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:procedureActivity.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Organizer

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Fixed: 1 element
Prohibited: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Organizer.templateId
  • The element 2 is sliced based on the values of Organizer.component

 

Other representations of profile: CSV, Excel