Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
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/MedicalEquipmentOrganizer | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: MedicalEquipmentOrganizer | |||
| Other Identifiers: id: urn: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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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 | ||
| id | 1..* | II | ||
| 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. | |
| @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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.statusCode.code | required | ResultStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| 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 |
| component:procedureActivity | 0..* | OrganizerComponent | ||
| procedure | C | 1..1 | ProcedureActivityProcedure | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.code | required | ResultStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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 | Organizer.component:procedureActivity.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 | Organizer.component:procedureActivity.procedure | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-performer | warning | Organizer.component:procedureActivity.procedure | SHOULD contain performer : performer.exists() | |
| should-quantity | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain quantity : quantity.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:procedureActivity.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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 | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| 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: CompressionAlgorithm (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: Binary Data Encoding Value Set (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) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (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: SetOperator (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 |
| 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 |
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:medical-equipment-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavor |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithm |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Organizer.sdtcText.mediaType | example | MediaType |
| Organizer.sdtcText.representation | required | BinaryDataEncoding |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | CDANullFlavor |
| Organizer.statusCode.code | required | ResultStatus |
| Organizer.effectiveTime.nullFlavor | required | CDANullFlavor |
| Organizer.effectiveTime.operator | required | SetOperator |
| Organizer.component:nonMedicalSupply.nullFlavor | required | CDANullFlavor |
| Organizer.component:nonMedicalSupply.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component:nonMedicalSupply.typeCode | required | ActRelationshipHasComponent |
| Organizer.component:procedureActivity.nullFlavor | required | CDANullFlavor |
| Organizer.component:procedureActivity.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component:procedureActivity.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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 | Organizer.component:procedureActivity.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 | Organizer.component:procedureActivity.procedure | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-performer | warning | Organizer.component:procedureActivity.procedure | SHOULD contain performer : performer.exists() | |
| should-quantity | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain quantity : quantity.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:procedureActivity.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If 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 Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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 | ||
| id | 1..* | II | ||
| 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. | |
| @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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.statusCode.code | required | ResultStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| 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 |
| component:procedureActivity | 0..* | OrganizerComponent | ||
| procedure | C | 1..1 | ProcedureActivityProcedure | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.code | required | ResultStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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 | Organizer.component:procedureActivity.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 | Organizer.component:procedureActivity.procedure | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-performer | warning | Organizer.component:procedureActivity.procedure | SHOULD contain performer : performer.exists() | |
| should-quantity | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain quantity : quantity.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:procedureActivity.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances 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 | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| 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: CompressionAlgorithm (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: Binary Data Encoding Value Set (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) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (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: SetOperator (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 |
| 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 |
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:medical-equipment-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavor |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithm |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Organizer.sdtcText.mediaType | example | MediaType |
| Organizer.sdtcText.representation | required | BinaryDataEncoding |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | CDANullFlavor |
| Organizer.statusCode.code | required | ResultStatus |
| Organizer.effectiveTime.nullFlavor | required | CDANullFlavor |
| Organizer.effectiveTime.operator | required | SetOperator |
| Organizer.component:nonMedicalSupply.nullFlavor | required | CDANullFlavor |
| Organizer.component:nonMedicalSupply.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component:nonMedicalSupply.typeCode | required | ActRelationshipHasComponent |
| Organizer.component:procedureActivity.nullFlavor | required | CDANullFlavor |
| Organizer.component:procedureActivity.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component:procedureActivity.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32380 | error | 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 | Organizer.component:procedureActivity.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 | Organizer.component:procedureActivity.procedure | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-performer | warning | Organizer.component:procedureActivity.procedure | SHOULD contain performer : performer.exists() | |
| should-quantity | warning | Organizer.component:nonMedicalSupply.supply | SHOULD contain quantity : quantity.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:procedureActivity.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:nonMedicalSupply.supply, Organizer.component:procedureActivity.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If 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 Value: 1 element
Prohibited: 1 element
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#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change