Consolidated CDA
3.0.0-ballot - ballot United States of America flag

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

Logical Model: Result Organizer

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ResultOrganizer Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: ResultOrganizer
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.1:2023-05-01

This template provides a mechanism for grouping result observations. It contains information applicable to all of the contained result observations. The Result Organizer code categorizes the contained results into one of several commonly accepted values (e.g., Hematology, Chemistry, Nuclear Medicine).

If any Result Observation within the organizer has a statusCode of “active”, the Result Organizer must also have a statusCode of “active”.

A specimen linked to a Result Organizer applies to all Result Observations. Centralizing specimen details within the Organizer is advised for clarity and consistency, as Result Observations typically relate to a single specimen collection, like using a purple top tube for CBCs. In cases of poor-quality specimens, a specimen reject reason is logically associated with the procedure, not the result, as there may be no result. The Result Organizer includes the specimen collection procedure, which may contain a reject reason.

Usage:

Formal Views of Profile Content

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

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:result-org 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... @moodCode 1..1cs
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csBinding: Result Status (required)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... low 1..1IVXB_TS
.... high 1..1IVXB_TS
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... id 1..*II
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... code 1..1CEBinding: Specimen type (preferred)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation 1..1ResultObservationBase for all types and resources
.... component:specimenProc 0..1OrganizerComponent
..... procedure 1..1SpecimenCollectionProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organizer.statusCode.coderequiredResultStatus
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:result-org 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1csBinding: ActMood (2.0.0) (required)
Fixed Value: EVN
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDXML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: Result Status (required)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... low 1..1IVXB_TS
.... high 1..1IVXB_TS
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... id 1..*II
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... @classCode 1..1csBinding: EntityClassRoot (required)
...... code 1..1CEBinding: Specimen type (preferred)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation C1..1ResultObservationBase for all types and resources
.... component:specimenProc 0..1OrganizerComponent
..... procedure C1..1SpecimenCollectionProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
Organizer.moodCoderequiredFixed Value: EVN
Organizer.codeexampleActCode
Organizer.statusCoderequiredActStatus
Organizer.statusCode.coderequiredResultStatus
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-authorwarningOrganizer.component:resultObs.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:specimenProc.procedureSHOULD contain effectiveTime
: effectiveTime.exists()
should-interpretationCodewarningOrganizer.component:resultObs.observationSHOULD contain interpretationCode
: interpretationCode.exists()
should-referenceRangewarningOrganizer.component:resultObs.observationSHOULD contain referenceRange
: referenceRange.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:specimenProc.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:resultObs.observation, Organizer.component:specimenProc.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:result-org 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1csBinding: ActMood (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDXML 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..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csBinding: Result Status (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high 1..1IVXB_TS
... subject 0..1Subject
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 0..1csBinding: RoleClassSpecimen (required)
Fixed Value: SPEC
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: EntityClassRoot (required)
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code 1..1CEBinding: Specimen type (preferred)
...... quantity 0..*PQ
...... name 0..*PN
...... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1ED
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1blFixed Value: true
..... sequenceNumber 0..1INT
..... sdtcPriorityNumber 0..1INTXML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1ResultObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... component:specimenProc 0..1OrganizerComponent
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1blFixed Value: true
..... sequenceNumber 0..1INT
..... sdtcPriorityNumber 0..1INTXML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure C1..1SpecimenCollectionProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.nullFlavorrequiredCDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
Organizer.templateId:result-org.nullFlavorrequiredCDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
Organizer.moodCoderequiredFixed Value: EVN
Organizer.codeexampleActCode
Organizer.sdtcText.nullFlavorrequiredCDANullFlavor
Organizer.sdtcText.compressionrequiredCDACompressionAlgorithm
Organizer.sdtcText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Organizer.sdtcText.mediaTypeexampleMediaType
Organizer.sdtcText.representationrequiredBinaryDataEncoding
Organizer.statusCoderequiredActStatus
Organizer.statusCode.nullFlavorrequiredCDANullFlavor
Organizer.statusCode.coderequiredResultStatus
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
Organizer.effectiveTime.operatorrequiredSetOperator
Organizer.specimen.nullFlavorrequiredCDANullFlavor
Organizer.specimen.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.typeCoderequiredFixed Value: SPC
Organizer.specimen.specimenRole.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.classCoderequiredFixed Value: SPEC
Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCoderequiredFixed Value: INSTANCE
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType
Organizer.component:resultObs.nullFlavorrequiredCDANullFlavor
Organizer.component:resultObs.typeId.nullFlavorrequiredCDANullFlavor
Organizer.component:resultObs.typeCoderequiredActRelationshipHasComponent
Organizer.component:specimenProc.nullFlavorrequiredCDANullFlavor
Organizer.component:specimenProc.typeId.nullFlavorrequiredCDANullFlavor
Organizer.component:specimenProc.typeCoderequiredActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-authorwarningOrganizer.component:resultObs.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:specimenProc.procedureSHOULD contain effectiveTime
: effectiveTime.exists()
should-interpretationCodewarningOrganizer.component:resultObs.observationSHOULD contain interpretationCode
: interpretationCode.exists()
should-referenceRangewarningOrganizer.component:resultObs.observationSHOULD contain referenceRange
: referenceRange.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:specimenProc.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:resultObs.observation, Organizer.component:specimenProc.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Organizer

Summary

Mandatory: 10 elements (6 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organizer.templateId is sliced based on the values of value:root, value:extension
  • The element Organizer.component is sliced based on the value of profile:observation

Differential View

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:result-org 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... @moodCode 1..1cs
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csBinding: Result Status (required)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... low 1..1IVXB_TS
.... high 1..1IVXB_TS
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... id 1..*II
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... code 1..1CEBinding: Specimen type (preferred)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation 1..1ResultObservationBase for all types and resources
.... component:specimenProc 0..1OrganizerComponent
..... procedure 1..1SpecimenCollectionProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organizer.statusCode.coderequiredResultStatus
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:result-org 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1csBinding: ActMood (2.0.0) (required)
Fixed Value: EVN
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDXML Namespace: urn:hl7-org:sdtc
SHOULD reference the portion of section narrative text corresponding to this entry
XML: text (urn:hl7-org:sdtc)
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: Result Status (required)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... low 1..1IVXB_TS
.... high 1..1IVXB_TS
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... id 1..*II
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... @classCode 1..1csBinding: EntityClassRoot (required)
...... code 1..1CEBinding: Specimen type (preferred)
... author 0..*AuthorParticipationBase for all types and resources
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation C1..1ResultObservationBase for all types and resources
.... component:specimenProc 0..1OrganizerComponent
..... procedure C1..1SpecimenCollectionProcedureBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
Organizer.moodCoderequiredFixed Value: EVN
Organizer.codeexampleActCode
Organizer.statusCoderequiredActStatus
Organizer.statusCode.coderequiredResultStatus
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-authorwarningOrganizer.component:resultObs.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:specimenProc.procedureSHOULD contain effectiveTime
: effectiveTime.exists()
should-interpretationCodewarningOrganizer.component:resultObs.observationSHOULD contain interpretationCode
: interpretationCode.exists()
should-referenceRangewarningOrganizer.component:resultObs.observationSHOULD contain referenceRange
: referenceRange.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:specimenProc.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:resultObs.observation, Organizer.component:specimenProc.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1OrganizerXML 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
should-author: SHOULD contain author
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:result-org 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.1
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1csBinding: ActMood (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code C1..1CDLaboratory results **SHOULD** be from LOINC (CodeSystem: 2.16.840.1.113883.6.1) or other constrained terminology named by the US Department of Health and Human Services Office of National Coordinator or other federal agency (CONF:4537-19219).
Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
... sdtcText 0..1EDXML 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..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 1..1csBinding: Result Status (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TSThe effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 0..1TS
.... width 0..1PQ
.... high 1..1IVXB_TS
... subject 0..1Subject
... specimen 0..*SpecimenWhen an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code.
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationType (required)
Fixed Value: SPC
.... specimenRole 1..1SpecimenRole(USCDI) Specimen Identifier
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 0..1csBinding: RoleClassSpecimen (required)
Fixed Value: SPEC
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... specimenPlayingEntity 1..1PlayingEntity(USCDI) Specimen Type
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: EntityClassRoot (required)
...... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... code 1..1CEBinding: Specimen type (preferred)
...... quantity 0..*PQ
...... name 0..*PN
...... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
...... desc 0..1ED
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... reference 0..*Reference
... precondition 0..*Precondition
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1blFixed Value: true
..... sequenceNumber 0..1INT
..... sdtcPriorityNumber 0..1INTXML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation C1..1ResultObservationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... component:specimenProc 0..1OrganizerComponent
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 0..1csBinding: ActRelationshipHasComponent (required)
..... @contextConductionInd 0..1blFixed Value: true
..... sequenceNumber 0..1INT
..... sdtcPriorityNumber 0..1INTXML Namespace: urn:hl7-org:sdtc
XML: priorityNumber (urn:hl7-org:sdtc)
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure C1..1SpecimenCollectionProcedureBase for all types and resources
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.nullFlavorrequiredCDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
Organizer.templateId:result-org.nullFlavorrequiredCDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
Organizer.moodCoderequiredFixed Value: EVN
Organizer.codeexampleActCode
Organizer.sdtcText.nullFlavorrequiredCDANullFlavor
Organizer.sdtcText.compressionrequiredCDACompressionAlgorithm
Organizer.sdtcText.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Organizer.sdtcText.mediaTypeexampleMediaType
Organizer.sdtcText.representationrequiredBinaryDataEncoding
Organizer.statusCoderequiredActStatus
Organizer.statusCode.nullFlavorrequiredCDANullFlavor
Organizer.statusCode.coderequiredResultStatus
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
Organizer.effectiveTime.operatorrequiredSetOperator
Organizer.specimen.nullFlavorrequiredCDANullFlavor
Organizer.specimen.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.typeCoderequiredFixed Value: SPC
Organizer.specimen.specimenRole.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.classCoderequiredFixed Value: SPEC
Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavorrequiredCDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCoderequiredFixed Value: INSTANCE
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType
Organizer.component:resultObs.nullFlavorrequiredCDANullFlavor
Organizer.component:resultObs.typeId.nullFlavorrequiredCDANullFlavor
Organizer.component:resultObs.typeCoderequiredActRelationshipHasComponent
Organizer.component:specimenProc.nullFlavorrequiredCDANullFlavor
Organizer.component:specimenProc.typeId.nullFlavorrequiredCDANullFlavor
Organizer.component:specimenProc.typeCoderequiredActRelationshipHasComponent

Constraints

IdGradePath(s)DetailsRequirements
4537-19218warningOrganizer.code**SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218).
: codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96'
should-authorwarningOrganizerSHOULD contain author
: author.exists()
should-authorwarningOrganizer.component:resultObs.observationSHOULD contain author
: author.exists()
should-effectiveTimewarningOrganizer.component:specimenProc.procedureSHOULD contain effectiveTime
: effectiveTime.exists()
should-interpretationCodewarningOrganizer.component:resultObs.observationSHOULD contain interpretationCode
: interpretationCode.exists()
should-referenceRangewarningOrganizer.component:resultObs.observationSHOULD contain referenceRange
: referenceRange.exists()
should-sdtctext-ref-valuewarningOrganizerSHOULD contain text/reference/@value
: sdtcText.reference.value.exists()
should-targetSiteCodewarningOrganizer.component:specimenProc.procedureSHOULD contain targetSiteCode
: targetSiteCode.exists()
should-text-ref-valuewarningOrganizer.component:resultObs.observation, Organizer.component:specimenProc.procedureSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorOrganizer.sdtcText.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Organizer

Summary

Mandatory: 10 elements (6 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organizer.templateId is sliced based on the values of value:root, value:extension
  • The element Organizer.component is sliced based on the value of profile:observation

 

Other representations of profile: CSV, Excel