Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.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

Logical Model: UDI Organizer

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/UDIOrganizer Version: 3.0.0
Draft as of 2024-05-18 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.

  • Device Identifier urn:hl7ii:2.16.840.1.113883.10.20.22.4.304: 2019-06-21 NCIt: C101722 SHALL be included in UDI Organizer
  • Lot or Batch Number urn:hl7ii:2.16.840.1.113883.10.20.22.4.315: 2019-06-21 NCIt:C101672 SHOULD be included in UDI Organizer if present in UDI
  • Serial Number urn:hl7ii:2.16.840.1.113883.10.20.22.4.319: 2019-06-21 NCIt: C101671 SHOULD be included in UDI Organizer if present in UDI
  • Manufacturing Date
    urn:hl7ii:2.16.840.1.113883.10.20.22.4.316: 2019-06-21 NCIt:C101669 SHOULD be included in UDI Organizer if present in UDI
  • Expiration Date urn:hl7ii:2.16.840.1.113883.10.20.22.4.309: 2019-06-21 NCIt: C101670 SHOULD be included in UDI Organizer if present in UDI
  • Distinct Identification Code urn:hl7ii:2.16.840.1.113883.10.20.22.4.308: 2019-06-21 NCIt: C113843 SHOULD be included in UDI Organizer if present in UDI
  • Brand Name urn:hl7ii:2.16.840.1.113883.10.20.22.4.301: 2019-06-21 NCIt: C71898 MAY be included in the UDI Organizer if available
  • Model Number urn:hl7ii:2.16.840.1.113883.10.20.22.4.317: 2019-06-21 NCIt: C99285 MAY be included in the UDI Organizer if available
  • Catalog Number urn:hl7ii:2.16.840.1.113883.10.20.22.4.302: 2019-06-21 NCIt: C99286 MAY be included in the UDI Organizer if available
  • Company Name urn:hl7ii:2.16.840.1.113883.10.20.22.4.303: 2019-06-21 NCIt: C54131 MAY be included in the UDI Organizer if available
  • MRI Safety urn:hl7ii:2.16.840.1.113883.10.20.22.4.318: 2019-06-21 NCIt: C106044 MAY be included in the UDI Organizer if available
  • Latex Safety urn:hl7ii:2.16.840.1.113883.10.20.22.4.314: 2019-06-21 NCIt: C160938 MAY be included in the UDI Organizer if available
  • Implantable Device Status urn:hl7ii:2.16.840.1.113883.10.20.22.4.305 2019-06-21 NCIt: C160939 MAY be included in the UDI Organizer if available

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

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, 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:UDI-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @classCode 1..1 cs Fixed Value: CLUSTER
... @moodCode 1..1 cs
.... @root 1..1 oid, uuid, ruid
... code 0..1 CD
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... 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
.... @code 1..1 cs Fixed Value: completed
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... observation 1..1 DeviceIdentifierObservation Base for all types and resources
.... component:otherObs 0..* OrganizerComponent
..... observation 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
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, 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:UDI-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
.... @root 1..1 oid, uuid, ruid
... code 0..1 CD Binding: v3 Code System ActCode (example)
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... 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 Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: completed
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... observation C 1..1 DeviceIdentifierObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... component:otherObs 0..* OrganizerComponent
..... observation C 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

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

Constraints

IdGradePath(s)DetailsRequirements
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-text-ref-valuewarningOrganizer.component:deviceObs.observation, Organizer.component:otherObs.observationSHOULD 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, 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
... @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:UDI-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.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @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..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid
.... @extension 0..1 st
... code 0..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... 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 Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: completed
.... @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 0..1 IVL_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 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... @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 C 1..1 DeviceIdentifierObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... component:otherObs 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 C 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... 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:UDI-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.id.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
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.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:otherObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:otherObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:otherObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-text-ref-valuewarningOrganizer.component:deviceObs.observation, Organizer.component:otherObs.observationSHOULD 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: 10 elements(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organizer.templateId
  • The element 1 is sliced based on the value 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, 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:UDI-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @classCode 1..1 cs Fixed Value: CLUSTER
... @moodCode 1..1 cs
.... @root 1..1 oid, uuid, ruid
... code 0..1 CD
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... 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
.... @code 1..1 cs Fixed Value: completed
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... observation 1..1 DeviceIdentifierObservation Base for all types and resources
.... component:otherObs 0..* OrganizerComponent
..... observation 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
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, 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
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:UDI-org 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @classCode 1..1 cs Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
Fixed Value: CLUSTER
... @moodCode 1..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
.... @root 1..1 oid, uuid, ruid
... code 0..1 CD Binding: v3 Code System ActCode (example)
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
... 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 Binding: ActStatus (required)
.... @code 1..1 cs Fixed Value: completed
... Slices for component 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... observation C 1..1 DeviceIdentifierObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
.... component:otherObs 0..* OrganizerComponent
..... observation C 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

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

Constraints

IdGradePath(s)DetailsRequirements
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-text-ref-valuewarningOrganizer.component:deviceObs.observation, Organizer.component:otherObs.observationSHOULD 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, 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
... @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:UDI-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.311
..... @extension 1..1 st Required Pattern: 2019-06-21
... @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..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid
.... @extension 0..1 st
... code 0..1 CD Binding: v3 Code System ActCode (example)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 0..1 cs Required Pattern: 74711-3
.... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1 st
.... @codeSystemVersion 0..1 st
.... @displayName 0..1 st
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1 ED
.... qualifier 0..* CR
.... translation 0..* CD
... 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 Binding: ActStatus (required)
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @code 1..1 cs Fixed Value: completed
.... @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 0..1 IVL_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 1..* OrganizerComponent Slice: Unordered, Open by profile:observation
.... component:deviceObs 1..1 OrganizerComponent component
..... @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 C 1..1 DeviceIdentifierObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
.... component:otherObs 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 C 1..1 LotOrBatchNumberObservation, SerialNumberObservation, ManufacturingDateObservation, ExpirationDateObservation, DistinctIdentificationCodeObservation, BrandNameObservation, ModelNumberObservation, CompanyNameObservation, CatalogNumberObservation, LatexSafetyObservation, MRISafetyObservation, ImplantableDeviceStatusObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... 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:UDI-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.id.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
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.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:deviceObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:otherObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:otherObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:otherObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-text-ref-valuewarningOrganizer.component:deviceObs.observation, Organizer.component:otherObs.observationSHOULD 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: 10 elements(2 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel