Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Patient Referral Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/PatientReferralAct Version: 2.1
Draft as of 2023-09-29 Computable Name: PatientReferralAct
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.140

This template represents the type of referral (e.g., for dental care, to a specialist, for aging problems) and represents whether the referral is for full care or shared care. It may contain a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: PCPR
... moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
..... extension 0..0
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CE
... author 0..*AuthorParticipationBase for all types and resources
... participant 0..*Participant2
.... typeCode 1..1csFixed Value: REFT
.... participantRole 1..1ParticipantRole
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1csFixed Value: SUBJ
..... observation 1..1Observation
...... classCode 1..1csFixed Value: OBS
...... moodCode 1..1csFixed Value: RQO
...... code 1..1CD
....... code 1..1csRequired Pattern: ASSERTION
....... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CS
....... code 1..1csFixed Value: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*EntryRelationship
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPatient Referral Act moodCode
Act.coderequiredReferral Types
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: PCPR
... @moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... author 0..*AuthorParticipationBase for all types and resources
... participant 0..*Participant2
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: REFT
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... observation 1..1Observation
...... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
...... @moodCode 1..1csFixed Value: RQO
...... code 1..1CDBinding: ObservationType (extensible)
....... @code 1..1csRequired Pattern: ASSERTION
....... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.moodCoderequiredPatient Referral Act moodCode
Act.coderequiredReferral Types
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.participant.typeCoderequiredFixed Value: REFT
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Act.entryRelationship:entryRelationship1.observation.classCoderequiredFixed Value: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: PCPR
... @moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... id 1..*IIIn the case of a Consultation Note where this referral is being fulfilled by this consultation, this id would be referenced in the inFullfilmentOf/order/id of the Consultation Note.
... code 1..1CDBinding: Referral Types (required)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @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 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: REFT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1Observation
...... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
...... @moodCode 1..1csFixed Value: RQO
...... @negationInd 0..1bl
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... code 1..1CDBinding: ObservationType (extensible)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 1..1csRequired Pattern: ASSERTION
....... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
....... @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
...... derivationExpr 0..1ST
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 1..1csFixed Value: completed
....... @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_TS
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... repeatNumber 0..1IVL_INT
...... languageCode 0..1CSBinding: HumanLanguage (required)
...... value 1..1CDBinding: Care Model (preferred)
...... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
...... methodCode 0..*CEBinding: ObservationMethod (extensible)
...... targetSiteCode 0..*CD
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
...... referenceRange 0..*InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
....... observationRange 1..1ObservationRange
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.moodCoderequiredPatient Referral Act moodCode
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.coderequiredReferral Types
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.participant.nullFlavorrequiredNullFlavor
Act.participant.typeCoderequiredFixed Value: REFT
Act.participant.contextControlCoderequiredFixed Value: OP
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Act.entryRelationship:entryRelationship1.observation.classCoderequiredFixed Value: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.code.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.statusCode.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model
Act.entryRelationship:entryRelationship1.observation.interpretationCoderequiredObservationInterpretation
Act.entryRelationship:entryRelationship1.observation.methodCodeextensibleObservationMethod
Act.entryRelationship:entryRelationship1.observation.referenceRange.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCoderequiredFixed Value: REFV
Act.entryRelationship:indication.nullFlavorrequiredNullFlavor
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 7 elements (8 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of profile:observation

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: PCPR
... moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
..... extension 0..0
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CS
.... code 1..1csFixed Value: active
... effectiveTime 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CE
... author 0..*AuthorParticipationBase for all types and resources
... participant 0..*Participant2
.... typeCode 1..1csFixed Value: REFT
.... participantRole 1..1ParticipantRole
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1csFixed Value: SUBJ
..... observation 1..1Observation
...... classCode 1..1csFixed Value: OBS
...... moodCode 1..1csFixed Value: RQO
...... code 1..1CD
....... code 1..1csRequired Pattern: ASSERTION
....... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CS
....... code 1..1csFixed Value: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*EntryRelationship
..... typeCode 1..1csFixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.moodCoderequiredPatient Referral Act moodCode
Act.coderequiredReferral Types
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: PCPR
... @moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: active
... effectiveTime 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... author 0..*AuthorParticipationBase for all types and resources
... participant 0..*Participant2
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: REFT
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... observation 1..1Observation
...... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
...... @moodCode 1..1csFixed Value: RQO
...... code 1..1CDBinding: ObservationType (extensible)
....... @code 1..1csRequired Pattern: ASSERTION
....... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CSBinding: ActStatus (required)
....... @code 1..1csFixed Value: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... observation 1..1IndicationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.moodCoderequiredPatient Referral Act moodCode
Act.coderequiredReferral Types
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.participant.typeCoderequiredFixed Value: REFT
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Act.entryRelationship:entryRelationship1.observation.classCoderequiredFixed Value: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: PCPR
... @moodCode 1..1csBinding: Patient Referral Act moodCode (required)
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... id 1..*IIIn the case of a Consultation Note where this referral is being fulfilled by this consultation, this id would be referenced in the inFullfilmentOf/order/id of the Consultation Note.
... code 1..1CDBinding: Referral Types (required)
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: active
.... @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 1..1IVL_TSThe effectiveTime represents the time when the future referral is intended to take place.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: REFT
.... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... @classCode 1..1csBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
..... addr 0..*AD
..... telecom 0..*TEL
..... playingDevice 0..1Device
..... playingEntity 0..1PlayingEntity
..... scopingEntity 0..1Entity
... Slices for entryRelationship 0..*EntryRelationshipThe following entryRelationship represents a reference to another act in the document instance representing the clinical reason for the referral (e.g., problem, concern, procedure).
Slice: Unordered, Open by profile:observation
.... entryRelationship:entryRelationship1 0..*EntryRelationshipThe following entryRelationship represents whether the referral is for full or shared care.
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1Observation
...... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
...... @moodCode 1..1csFixed Value: RQO
...... @negationInd 0..1bl
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... code 1..1CDBinding: ObservationType (extensible)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 1..1csRequired Pattern: ASSERTION
....... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.5.4
....... @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
...... derivationExpr 0..1ST
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... @code 1..1csFixed Value: completed
....... @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_TS
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... repeatNumber 0..1IVL_INT
...... languageCode 0..1CSBinding: HumanLanguage (required)
...... value 1..1CDBinding: Care Model (preferred)
...... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
...... methodCode 0..*CEBinding: ObservationMethod (extensible)
...... targetSiteCode 0..*CD
...... subject 0..1Subject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Informant
...... participant 0..*Participant2
...... entryRelationship 0..*EntryRelationship
...... reference 0..*Reference
...... precondition 0..*Precondition
...... referenceRange 0..*InfrastructureRoot
....... @nullFlavor 0..1csBinding: NullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
....... templateId 0..*II
....... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
....... observationRange 1..1ObservationRange
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
.... entryRelationship:indication 0..*EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: RSON
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 1..1IndicationBase for all types and resources
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.moodCoderequiredPatient Referral Act moodCode
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.coderequiredReferral Types
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.participant.nullFlavorrequiredNullFlavor
Act.participant.typeCoderequiredFixed Value: REFT
Act.participant.contextControlCoderequiredFixed Value: OP
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: SUBJ
Act.entryRelationship:entryRelationship1.observation.classCoderequiredFixed Value: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.code.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.statusCode.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model
Act.entryRelationship:entryRelationship1.observation.interpretationCoderequiredObservationInterpretation
Act.entryRelationship:entryRelationship1.observation.methodCodeextensibleObservationMethod
Act.entryRelationship:entryRelationship1.observation.referenceRange.nullFlavorrequiredNullFlavor
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCoderequiredFixed Value: REFV
Act.entryRelationship:indication.nullFlavorrequiredNullFlavor
Act.entryRelationship:indication.typeCoderequiredFixed Value: RSON

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 7 elements (8 nested mandatory elements)
Fixed Value: 8 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of profile:observation

 

Other representations of profile: CSV, Excel