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/UDIOrganizer | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: UDIOrganizer | |||
| Other Identifiers: id: 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.
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 |
  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 | ||
| id | 1..1 | II | ||
 @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 | |
 component | 1..1 | OrganizerComponent | ||
 observation | 1..1 | DeviceIdentifierObservation | Base for all types and resources | |
| Documentation for this format | ||||
| 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('#') |
| 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 |
| 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..1 | II | ||
| @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 | |
| component | 1..1 | OrganizerComponent | ||
| observation | C | 1..1 | DeviceIdentifierObservation | 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 |
| Id | Grade | Path(s) | Details | Requirements |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | 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('#') |
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.id.nullFlavor | required | CDANullFlavor |
| Organizer.code | example | ActCode |
| Organizer.code.nullFlavor | required | CDANullFlavor |
| 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.component.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | 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: 9 elements (1 nested mandatory element)
Fixed Value: 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
| 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 |
| 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 | ||
| id | 1..1 | II | ||
| @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 | |
| component | 1..1 | OrganizerComponent | ||
| observation | 1..1 | DeviceIdentifierObservation | Base for all types and resources | |
| Documentation for this format | ||||
| 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
| 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 |
| 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: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..1 | II | ||
| @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 | |
| component | 1..1 | OrganizerComponent | ||
| observation | C | 1..1 | DeviceIdentifierObservation | 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 |
| Id | Grade | Path(s) | Details | Requirements |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | 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
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:UDI-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.id.nullFlavor | required | CDANullFlavor |
| Organizer.code | example | ActCode |
| Organizer.code.nullFlavor | required | CDANullFlavor |
| 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.component.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | 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: 9 elements (1 nested mandatory element)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#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