This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/UDIOrganizer | Version: 4.0.0 | |||
Draft as of 2025-06-20 | Computable Name: UDIOrganizer | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.311:2019-06-21 |
This template is nested in an entryRelationship/Procedure Activity Procedure to record all the UDI-related templates to exchange the parsed UDI data elements and associated data.
Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:
Required Components: DeviceIdentifierObservation
Optional Components: BrandNameObservation, CatalogNumberObservation, CompanyNameObservation, DistinctIdentificationCodeObservation, ExpirationDateObservation, ImplantableDeviceStatusObservation, LatexSafetyObservation, LotOrBatchNumberObservation, MRISafetyObservation, ManufacturingDateObservation, ModelNumberObservation, SerialNumberObservation
Usages:
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
Id | Grade | Path(s) | Details | Requirements |
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('#') |
Path | Conformance | ValueSet / Code | URI |
Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Organizer.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
Organizer.component:otherObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Organizer.typeId, Organizer.component:deviceObs.typeId, Organizer.component:otherObs.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
Path | Conformance | ValueSet / Code | URI |
Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Organizer.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
Organizer.component:otherObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Organizer.typeId, Organizer.component:deviceObs.typeId, Organizer.component:otherObs.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements(2 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organizer
Id | Grade | Path(s) | Details | Requirements |
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
Path | Conformance | ValueSet / Code | URI |
Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Organizer.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
Organizer.component:otherObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Organizer.typeId, Organizer.component:deviceObs.typeId, Organizer.component:otherObs.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Organizer.id.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:deviceObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
Organizer.component:otherObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Organizer.component:otherObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Organizer.typeId, Organizer.component:deviceObs.typeId, Organizer.component:otherObs.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements(2 nested mandatory elements)
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: