Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Patient Referral Act

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.140 Version: 2.1.0-draft1
Active as of 2023-01-16 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 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: 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..1codeRequired Pattern: REFT
.... participantRole 1..1ParticipantRole
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*ElementThe 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..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... observation 1..1Observation
...... classCode 1..1codeRequired Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... code 1..1CD
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CS
....... code 1..1stringRequired Pattern: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: 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.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: 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..1codeBinding: ParticipationType (required)
Required Pattern: REFT
.... participantRole 1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship C0..*ElementThe 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:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryRelationship1 C0..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... contextConductionInd 1..1boolean
..... observation 1..1Observation
...... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... code 1..1CDBinding: ObservationType (extensible)
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CSBinding: ActStatus (required)
....... code 1..1stringRequired Pattern: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... 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.typeCoderequiredPattern: REFT
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.observation.classCoderequiredPattern: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
..... extension 0..1string
... 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..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: REFT
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: 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 C0..*ElementThe 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:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:entryRelationship1 C0..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Observation
...... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... negationInd 0..1boolean
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... code 1..1CDBinding: ObservationType (extensible)
....... nullFlavor 0..1codeBinding: NullFlavor (required)
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
....... codeSystemName 0..1string
....... codeSystemVersion 0..1string
....... displayName 0..1string
....... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
....... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
....... originalText 0..1ED
....... qualifier 0..*CR
....... translation 0..*CD
...... derivationExpr 0..1ED
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... nullFlavor 0..1codeBinding: NullFlavor (required)
....... code 1..1stringRequired Pattern: completed
....... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
....... sdtcValueSetVersion 0..1stringXML: 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..1Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
....... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
....... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
....... relatedSubject 1..1RelatedSubject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
....... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
....... assignedEntity 0..1AssignedEntity
....... relatedEntity 0..1RelatedEntity
...... participant 0..*Participant2
...... entryRelationship C0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1code
....... inversionInd 0..1boolean
....... contextConductionInd 1..1boolean
....... sequenceNumber 0..1INT
....... negationInd 0..1boolean
....... seperatableInd 0..1BL
....... (Choice of one) 1..1
........ observation 0..1Observation
........ regionOfInterest 0..1RegionOfInterest
........ observationMedia 0..1ObservationMedia
........ substanceAdministration 0..1SubstanceAdministration
........ supply 0..1Supply
........ procedure 0..1Procedure
........ encounter 0..1Encounter
........ organizer 0..1Organizer
........ act 0..1Act
...... reference 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1code
....... seperatableInd 0..1BL
....... externalAct 0..1ExternalAct
....... externalObservation 0..1ExternalObservation
....... externalProcedure 0..1ExternalProcedure
....... externalDocument 0..1ExternalDocument
...... precondition 0..*Precondition
...... referenceRange 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ActRelationshipPertains (required)
Fixed Value: REFV
....... observationRange 1..1ObservationRange
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
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.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP
Act.participant.nullFlavorrequiredNullFlavor
Act.participant.typeCoderequiredPattern: 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.observation.classCoderequiredPattern: 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.subject.typeCoderequiredFixed Value: SBJ
Act.entryRelationship:entryRelationship1.observation.subject.contextControlCoderequiredFixed Value: OP
Act.entryRelationship:entryRelationship1.observation.subject.awarenessCodeextensibleTargetAwareness
Act.entryRelationship:entryRelationship1.observation.informant.typeCoderequiredFixed Value: INF
Act.entryRelationship:entryRelationship1.observation.informant.contextControlCoderequiredFixed Value: OP
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorAct.entryRelationship:entryRelationship1.observation.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Act

Summary

Mandatory: 9 elements (14 nested mandatory elements)

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 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: 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..1codeRequired Pattern: REFT
.... participantRole 1..1ParticipantRole
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship 0..*ElementThe 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..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... observation 1..1Observation
...... classCode 1..1codeRequired Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... code 1..1CD
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CS
....... code 1..1stringRequired Pattern: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: 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.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
... code 1..1CDBinding: Referral Types (required)
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: 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..1codeBinding: ParticipationType (required)
Required Pattern: REFT
.... participantRole 1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
... Slices for entryRelationship C0..*ElementThe 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:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:entryRelationship1 C0..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... typeCode 1..1codeRequired Pattern: SUBJ
..... contextConductionInd 1..1boolean
..... observation 1..1Observation
...... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... code 1..1CDBinding: ObservationType (extensible)
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
...... statusCode 1..1CSBinding: ActStatus (required)
....... code 1..1stringRequired Pattern: completed
...... priorityCode 0..1CEBinding: ActPriority (preferred)
...... value 1..1CDBinding: Care Model (preferred)
.... entryRelationship:indication C0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... contextConductionInd 1..1boolean
..... 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.typeCoderequiredPattern: REFT
Act.participant.participantRole.classCoderequiredRoleClassRoot
Act.participant.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.entryRelationship:entryRelationship1.observation.classCoderequiredPattern: OBS
Act.entryRelationship:entryRelationship1.observation.codeextensibleObservationType
Act.entryRelationship:entryRelationship1.observation.statusCoderequiredActStatus
Act.entryRelationship:entryRelationship1.observation.priorityCodepreferredActPriority
Act.entryRelationship:entryRelationship1.observation.valuepreferredCare Model

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
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.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: PCPR
... moodCode 1..1codeBinding: Patient Referral Act moodCode (required)
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.140
..... extension 0..1string
... 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..1boolean
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: active
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: 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..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*AuthorParticipationBase for all types and resources
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: REFT
.... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... awarenessCode 0..1CE
.... participantRole 1..1ParticipantRole
..... classCode 1..1codeBinding: RoleClassRoot (required)
..... templateId 0..*II
..... id 0..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML: 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 C0..*ElementThe 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:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:entryRelationship1 C0..*ElementThe following entryRelationship represents whether the referral is for full or shared care.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Observation
...... classCode 1..1codeBinding: ActClassObservation (required)
Required Pattern: OBS
...... moodCode 1..1codeRequired Pattern: RQO
...... negationInd 0..1boolean
...... realmCode 0..*CS
...... typeId 0..1II
...... templateId 0..*II
...... id 0..*II
...... code 1..1CDBinding: ObservationType (extensible)
....... nullFlavor 0..1codeBinding: NullFlavor (required)
....... code 1..1stringRequired Pattern: ASSERTION
....... codeSystem 1..1stringRequired Pattern: 2.16.840.1.113883.5.4
....... codeSystemName 0..1string
....... codeSystemVersion 0..1string
....... displayName 0..1string
....... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
....... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
....... originalText 0..1ED
....... qualifier 0..*CR
....... translation 0..*CD
...... derivationExpr 0..1ED
...... text 0..1ED
...... statusCode 1..1CSBinding: ActStatus (required)
....... nullFlavor 0..1codeBinding: NullFlavor (required)
....... code 1..1stringRequired Pattern: completed
....... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
....... sdtcValueSetVersion 0..1stringXML: 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..1Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
....... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
....... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
....... relatedSubject 1..1RelatedSubject
...... specimen 0..*Specimen
...... performer 0..*Performer2
...... author 0..*Author
...... informant 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
....... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
....... assignedEntity 0..1AssignedEntity
....... relatedEntity 0..1RelatedEntity
...... participant 0..*Participant2
...... entryRelationship C0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1code
....... inversionInd 0..1boolean
....... contextConductionInd 1..1boolean
....... sequenceNumber 0..1INT
....... negationInd 0..1boolean
....... seperatableInd 0..1BL
....... (Choice of one) 1..1
........ observation 0..1Observation
........ regionOfInterest 0..1RegionOfInterest
........ observationMedia 0..1ObservationMedia
........ substanceAdministration 0..1SubstanceAdministration
........ supply 0..1Supply
........ procedure 0..1Procedure
........ encounter 0..1Encounter
........ organizer 0..1Organizer
........ act 0..1Act
...... reference 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1code
....... seperatableInd 0..1BL
....... externalAct 0..1ExternalAct
....... externalObservation 0..1ExternalObservation
....... externalProcedure 0..1ExternalProcedure
....... externalDocument 0..1ExternalDocument
...... precondition 0..*Precondition
...... referenceRange 0..*Element
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... typeCode 1..1codeBinding: ActRelationshipPertains (required)
Fixed Value: REFV
....... observationRange 1..1ObservationRange
.... entryRelationship:indication C0..*Element
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1IndicationBase for all types and resources
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
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.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP
Act.participant.nullFlavorrequiredNullFlavor
Act.participant.typeCoderequiredPattern: 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.observation.classCoderequiredPattern: 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.subject.typeCoderequiredFixed Value: SBJ
Act.entryRelationship:entryRelationship1.observation.subject.contextControlCoderequiredFixed Value: OP
Act.entryRelationship:entryRelationship1.observation.subject.awarenessCodeextensibleTargetAwareness
Act.entryRelationship:entryRelationship1.observation.informant.typeCoderequiredFixed Value: INF
Act.entryRelationship:entryRelationship1.observation.informant.contextControlCoderequiredFixed Value: OP
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-er-1errorAct.entryRelationship:entryRelationship1.observation.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Act

Summary

Mandatory: 9 elements (14 nested mandatory elements)

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, Schematron