Specialty Eyecare CDA Implementation Guide
0.1.0 - ci-build

Specialty Eyecare CDA Implementation Guide, published by Dogwood Health Consulting. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cda-eyecare/ and changes regularly. See the Directory of published versions

Logical Model: VisualAcuityOrganizer

Official URL: http://hl7.org/cda/us/eyecare/StructureDefinition/VisualAcuityOrganizer Version: 0.1.0
Draft as of 2024-02-07 Computable Name: VisualAcuityOrganizer

A constraint on ResultOrganizer that allows for VisualAcuityObservations.

Usage:

Formal Views of Profile Content

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

This structure is derived from ResultOrganizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... code
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
... component:resultObs 1..*OrganizerComponentcomponent
.... observation 1..1VisualAcuityObservation, AidToVisionObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... 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)
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: Result Status (required)
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation C1..1VisualAcuityObservation, AidToVisionObservationBase 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 / CodeURI
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood|2.0.0
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResult Status
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

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-authorwarningOrganizer, Organizer.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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... 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..1TEL
.... 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..1VisualAcuityObservation, AidToVisionObservationBase 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 / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:result-org.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood|2.0.0
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG
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.statusCode.coderequiredResult Status
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredSetOperator
http://terminology.hl7.org/ValueSet/v3-SetOperator
Organizer.specimen.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.typeCoderequiredFixed Value: SPC
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Organizer.specimen.specimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen
Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54
Organizer.component:resultObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:resultObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:resultObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:specimenProc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:specimenProc.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:specimenProc.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

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-authorwarningOrganizer, Organizer.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('#')

Differential View

This structure is derived from ResultOrganizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... code
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
... component:resultObs 1..*OrganizerComponentcomponent
.... observation 1..1VisualAcuityObservation, AidToVisionObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... 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)
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: Result Status (required)
... Slices for component 1..*OrganizerComponentSlice: Unordered, Open by profile:observation
.... component:resultObs 1..*OrganizerComponentcomponent
..... observation C1..1VisualAcuityObservation, AidToVisionObservationBase 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 / CodeURI
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood|2.0.0
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG
Organizer.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Organizer.statusCode.coderequiredResult Status
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39

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-authorwarningOrganizer, Organizer.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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer C1..1ResultOrganizerXML 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, templateId, templateId, classCode, moodCode, id, code, sdtcText, statusCode, effectiveTime, specimen, author, component, component, component
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @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)
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @code 0..1csBinding: Visual Acuity Organizer Codes (required)
.... @codeSystem 0..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @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)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... 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..1TEL
.... 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..1VisualAcuityObservation, AidToVisionObservationBase 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 / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:result-org.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood|2.0.0
Organizer.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Organizer.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.code.coderequiredVisualAcuityOrganizerCodes
http://hl7.org/cda/us/eyecare/ValueSet/VisualAcuityOrganizerCodes
from this IG
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.statusCode.coderequiredResult Status
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredSetOperator
http://terminology.hl7.org/ValueSet/v3-SetOperator
Organizer.specimen.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.typeCoderequiredFixed Value: SPC
http://terminology.hl7.org/ValueSet/v3-ParticipationType
Organizer.specimen.specimenRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.classCoderequiredFixed Value: SPEC
http://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen
Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.specimen.specimenRole.specimenPlayingEntity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Organizer.specimen.specimenRole.specimenPlayingEntity.codepreferredSpecimenType
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54
Organizer.component:resultObs.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:resultObs.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:resultObs.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent
Organizer.component:specimenProc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:specimenProc.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.component:specimenProc.typeCoderequiredActRelationshipHasComponent
http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent

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-authorwarningOrganizer, Organizer.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('#')

 

Other representations of profile: CSV, Excel