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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | ||
author | 0..* | AuthorParticipation | Base for all types and resources | |
participant | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: REFT | |
participantRole | 1..1 | ParticipantRole | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
Slices for entryRelationship | 0..* | Element | The 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..* | Element | The following entryRelationship represents whether the referral is for full or shared care. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.moodCode | required | Patient Referral Act moodCode |
Act.code | required | Referral Types |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
participant | 0..* | Participant2 | ||
typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: REFT | |
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | code | Binding: RoleClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
Slices for entryRelationship | C | 0..* | Element | The 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..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:entryRelationship1 | C | 0..* | Element | The following entryRelationship represents whether the referral is for full or shared care. |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: completed | |
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
entryRelationship:indication | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: RSON | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | Indication | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.moodCode | required | Patient Referral Act moodCode |
Act.code | required | Referral Types |
Act.statusCode | required | ActStatus |
Act.priorityCode | extensible | ActPriority |
Act.participant.typeCode | required | Pattern: REFT |
Act.participant.participantRole.classCode | required | RoleClassRoot |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.classCode | required | Pattern: OBS |
Act.entryRelationship:entryRelationship1.observation.code | extensible | ObservationType |
Act.entryRelationship:entryRelationship1.observation.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
extension | 0..1 | string | ||
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
negationInd | 0..1 | boolean | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: active | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
subject | 0..1 | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | AuthorParticipation | Base for all types and resources | |
informant | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: REFT | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | code | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 0..* | AD | ||
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
scopingEntity | 0..1 | Entity | ||
Slices for entryRelationship | C | 0..* | Element | The 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..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
entryRelationship:entryRelationship1 | C | 0..* | Element | The following entryRelationship represents whether the referral is for full or shared care. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
negationInd | 0..1 | boolean | ||
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
id | 0..* | II | ||
code | 1..1 | CD | Binding: ObservationType (extensible) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
codeSystemName | 0..1 | string | ||
codeSystemVersion | 0..1 | string | ||
displayName | 0..1 | string | ||
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
derivationExpr | 0..1 | ED | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: completed | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
repeatNumber | 0..1 | IVL_INT | ||
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
methodCode | 0..* | CE | Binding: ObservationMethod (extensible) | |
targetSiteCode | 0..* | CD | ||
subject | 0..1 | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | Author | ||
informant | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
entryRelationship | C | 0..* | Element | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
reference | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
referenceRange | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
observationRange | 1..1 | ObservationRange | ||
entryRelationship:indication | C | 0..* | Element | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Required Pattern: RSON | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Indication | Base for all types and resources | |
reference | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.moodCode | required | Patient Referral Act moodCode |
Act.templateId:primary.nullFlavor | required | NullFlavor |
Act.code | required | Referral Types |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.subject.typeCode | required | Fixed Value: SBJ |
Act.subject.contextControlCode | required | Fixed Value: OP |
Act.subject.awarenessCode | extensible | TargetAwareness |
Act.informant.typeCode | required | Fixed Value: INF |
Act.informant.contextControlCode | required | Fixed Value: OP |
Act.participant.nullFlavor | required | NullFlavor |
Act.participant.typeCode | required | Pattern: REFT |
Act.participant.contextControlCode | required | Fixed Value: OP |
Act.participant.participantRole.classCode | required | RoleClassRoot |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.classCode | required | Pattern: OBS |
Act.entryRelationship:entryRelationship1.observation.code | extensible | ObservationType |
Act.entryRelationship:entryRelationship1.observation.code.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.observation.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.observation.statusCode.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Act.entryRelationship:entryRelationship1.observation.interpretationCode | required | ObservationInterpretation |
Act.entryRelationship:entryRelationship1.observation.methodCode | extensible | ObservationMethod |
Act.entryRelationship:entryRelationship1.observation.subject.typeCode | required | Fixed Value: SBJ |
Act.entryRelationship:entryRelationship1.observation.subject.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.observation.subject.awarenessCode | extensible | TargetAwareness |
Act.entryRelationship:entryRelationship1.observation.informant.typeCode | required | Fixed Value: INF |
Act.entryRelationship:entryRelationship1.observation.informant.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Act.entryRelationship:entryRelationship1.observation.entryRelationship | Only 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:
Differential View
This structure is derived from CDAR2.Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | ||
author | 0..* | AuthorParticipation | Base for all types and resources | |
participant | 0..* | Participant2 | ||
typeCode | 1..1 | code | Required Pattern: REFT | |
participantRole | 1..1 | ParticipantRole | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
Slices for entryRelationship | 0..* | Element | The 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..* | Element | The following entryRelationship represents whether the referral is for full or shared care. | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
code | 1..1 | CD | ||
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
entryRelationship:indication | 0..* | Element | ||
typeCode | 1..1 | code | Required Pattern: RSON | |
observation | 1..1 | Indication | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet |
Act.moodCode | required | Patient Referral Act moodCode |
Act.code | required | Referral Types |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: active | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
author | 0..* | AuthorParticipation | Base for all types and resources | |
participant | 0..* | Participant2 | ||
typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: REFT | |
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | code | Binding: RoleClassRoot (required) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
Slices for entryRelationship | C | 0..* | Element | The 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..1 | code | ||
contextConductionInd | 1..1 | boolean | ||
entryRelationship:entryRelationship1 | C | 0..* | Element | The following entryRelationship represents whether the referral is for full or shared care. |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
code | 1..1 | CD | Binding: ObservationType (extensible) | |
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
code | 1..1 | string | Required Pattern: completed | |
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
entryRelationship:indication | C | 0..* | Element | |
typeCode | 1..1 | code | Required Pattern: RSON | |
contextConductionInd | 1..1 | boolean | ||
observation | 1..1 | Indication | Base for all types and resources | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.moodCode | required | Patient Referral Act moodCode |
Act.code | required | Referral Types |
Act.statusCode | required | ActStatus |
Act.priorityCode | extensible | ActPriority |
Act.participant.typeCode | required | Pattern: REFT |
Act.participant.participantRole.classCode | required | RoleClassRoot |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.classCode | required | Pattern: OBS |
Act.entryRelationship:entryRelationship1.observation.code | extensible | ObservationType |
Act.entryRelationship:entryRelationship1.observation.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 1..1 | CDAR2.Act | Base for all types and resources | |
classCode | 1..1 | code | Required Pattern: PCPR | |
moodCode | 1..1 | code | Binding: Patient Referral Act moodCode (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.140 | |
extension | 0..1 | string | ||
id | 1..* | II | In 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..1 | CD | Binding: Referral Types (required) | |
negationInd | 0..1 | boolean | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: active | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | The effectiveTime represents the time when the future referral is intended to take place. | |
priorityCode | 0..1 | CE | Binding: ActPriority (extensible) | |
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
subject | 0..1 | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | AuthorParticipation | Base for all types and resources | |
informant | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 1..1 | code | Binding: ParticipationType (required) Required Pattern: REFT | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | 1..1 | ParticipantRole | ||
classCode | 1..1 | code | Binding: RoleClassRoot (required) | |
templateId | 0..* | II | ||
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 0..* | AD | ||
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
scopingEntity | 0..1 | Entity | ||
Slices for entryRelationship | C | 0..* | Element | The 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..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
entryRelationship:entryRelationship1 | C | 0..* | Element | The following entryRelationship represents whether the referral is for full or shared care. |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Required Pattern: SUBJ | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Observation | ||
classCode | 1..1 | code | Binding: ActClassObservation (required) Required Pattern: OBS | |
moodCode | 1..1 | code | Required Pattern: RQO | |
negationInd | 0..1 | boolean | ||
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
templateId | 0..* | II | ||
id | 0..* | II | ||
code | 1..1 | CD | Binding: ObservationType (extensible) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: ASSERTION | |
codeSystem | 1..1 | string | Required Pattern: 2.16.840.1.113883.5.4 | |
codeSystemName | 0..1 | string | ||
codeSystemVersion | 0..1 | string | ||
displayName | 0..1 | string | ||
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
derivationExpr | 0..1 | ED | ||
text | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: completed | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
priorityCode | 0..1 | CE | Binding: ActPriority (preferred) | |
repeatNumber | 0..1 | IVL_INT | ||
languageCode | 0..1 | CS | Binding: HumanLanguage (required) | |
value | 1..1 | CD | Binding: Care Model (preferred) | |
interpretationCode | 0..* | CE | Binding: ObservationInterpretation (required) | |
methodCode | 0..* | CE | Binding: ObservationMethod (extensible) | |
targetSiteCode | 0..* | CD | ||
subject | 0..1 | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | Author | ||
informant | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
entryRelationship | C | 0..* | Element | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
(Choice of one) | 1..1 | |||
observation | 0..1 | Observation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
reference | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
referenceRange | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Binding: ActRelationshipPertains (required) Fixed Value: REFV | |
observationRange | 1..1 | ObservationRange | ||
entryRelationship:indication | C | 0..* | Element | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | Required Pattern: RSON | |
inversionInd | 0..1 | boolean | ||
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
negationInd | 0..1 | boolean | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | Indication | Base for all types and resources | |
reference | 0..* | Element | ||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.moodCode | required | Patient Referral Act moodCode |
Act.templateId:primary.nullFlavor | required | NullFlavor |
Act.code | required | Referral Types |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | NullFlavor |
Act.priorityCode | extensible | ActPriority |
Act.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.subject.typeCode | required | Fixed Value: SBJ |
Act.subject.contextControlCode | required | Fixed Value: OP |
Act.subject.awarenessCode | extensible | TargetAwareness |
Act.informant.typeCode | required | Fixed Value: INF |
Act.informant.contextControlCode | required | Fixed Value: OP |
Act.participant.nullFlavor | required | NullFlavor |
Act.participant.typeCode | required | Pattern: REFT |
Act.participant.contextControlCode | required | Fixed Value: OP |
Act.participant.participantRole.classCode | required | RoleClassRoot |
Act.participant.participantRole.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.entryRelationship:entryRelationship1.observation.classCode | required | Pattern: OBS |
Act.entryRelationship:entryRelationship1.observation.code | extensible | ObservationType |
Act.entryRelationship:entryRelationship1.observation.code.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.observation.statusCode | required | ActStatus |
Act.entryRelationship:entryRelationship1.observation.statusCode.nullFlavor | required | NullFlavor |
Act.entryRelationship:entryRelationship1.observation.priorityCode | preferred | ActPriority |
Act.entryRelationship:entryRelationship1.observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066 ) |
Act.entryRelationship:entryRelationship1.observation.value | preferred | Care Model |
Act.entryRelationship:entryRelationship1.observation.interpretationCode | required | ObservationInterpretation |
Act.entryRelationship:entryRelationship1.observation.methodCode | extensible | ObservationMethod |
Act.entryRelationship:entryRelationship1.observation.subject.typeCode | required | Fixed Value: SBJ |
Act.entryRelationship:entryRelationship1.observation.subject.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.observation.subject.awarenessCode | extensible | TargetAwareness |
Act.entryRelationship:entryRelationship1.observation.informant.typeCode | required | Fixed Value: INF |
Act.entryRelationship:entryRelationship1.observation.informant.contextControlCode | required | Fixed Value: OP |
Act.entryRelationship:entryRelationship1.observation.referenceRange.typeCode | required | Fixed Value: REFV |
Id | Grade | Path(s) | Details | Requirements |
act-er-1 | error | Act.entryRelationship, Act.entryRelationship:entryRelationship1, Act.entryRelationship:indication | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
obs-er-1 | error | Act.entryRelationship:entryRelationship1.observation.entryRelationship | Only 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:
Other representations of profile: CSV, Excel, Schematron