HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

ReferralRequest

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRequest

Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.

This profile builds on ReferralRequest.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ReferralRequest maps to ReferralRequest:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Status maps to status
  Identifier maps to identifier
  StatementDateTime maps to date
  Replaces maps to extension
  RequestIntent maps to extension
  Type maps to type
  PriorityCode maps to priority
  ReferralSubjectOfRecord maps to patient
  ReferralRequester maps to requester
  Recipient maps to recipient
  CareContext maps to encounter
  ReasonCode maps to reason
  ReasonReference maps to extension
  CommentOrDescription maps to description
  ServiceType maps to serviceRequested
  RelatedInformation maps to supportingInformation
  ExpectedPerformanceTime maps to fulfillmentTime
  ExpectedPerformerType maps to extension
  Annotation maps to extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest shr-core-ReferralRequest
... extension 1..*Slice: Unordered, Open by value:url
... shr-core-Replaces-extension 0..*Reference(shr-core-ActionRequested)Replaces
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension
.... valueReference Reference(shr-core-ReferralRequest)ReferralRequest
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... valueCodeableConcept Binding: request-intent (required)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-Annotation-extension 0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Annotation-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-ReferralRecipient-extension 0..*Reference(shr-core-Practitioner | shr-core-Organization)ReferralRecipient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRecipient-extension
... type Binding: referral-type (example)
... priority Binding: request-priority (required)
... patient 1..1Reference(shr-core-Patient)
... requester Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient)
... recipient 0..1Reference(shr-core-Practitioner | shr-core-Organization)
... encounter Reference(shr-core-Encounter)
... serviceRequested Binding: service-type (example)
... supportingInformation Reference(shr-core-DomainResource)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*shr-core-ReferralRequest
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Replaces-extension 0..*Reference(shr-core-ActionRequested)Replaces
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension"
.... valueReference 1..1Reference(shr-core-ReferralRequest)ReferralRequest
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: request-intent (required)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-Annotation-extension 0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Annotation-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-ReferralRecipient-extension 0..*Reference(shr-core-Practitioner | shr-core-Organization)ReferralRecipient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRecipient-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | requested | active | cancelled | accepted | rejected | completed
Binding: ReferralStatus (required)
... identifier 0..*IdentifierBusiness identifier
... date Σ0..1dateTimeDate of creation/activation
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: referral-type (example)
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... priority Σ0..1CodeableConceptUrgency of referral / transfer of care request
Binding: request-priority (required)
... patient Σ1..1Reference(shr-core-Patient)Patient referred to care or transfer
... requester Σ0..1Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient)Requester of referral / transfer of care
... recipient Σ0..1Reference(shr-core-Practitioner | shr-core-Organization)Receiver of referral / transfer of care request
... encounter 0..1Reference(shr-core-Encounter)Originating encounter
... dateSent Σ0..1dateTimeDate referral/transfer of care request is sent
... reason Σ0..1CodeableConceptReason for referral / transfer of care request
Binding: (unbound) (example)
... description 0..1stringA textual description of the referral
... serviceRequested Σ0..*CodeableConceptActions requested as part of the referral
Binding: service-type (example)
... supportingInformation Σ0..*Reference(shr-core-DomainResource)Additonal information to support referral or transfer of care request
... fulfillmentTime Σ0..1PeriodRequested service(s) fulfillment time

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.ReferralRequest maps to ReferralRequest:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Status maps to status
  Identifier maps to identifier
  StatementDateTime maps to date
  Replaces maps to extension
  RequestIntent maps to extension
  Type maps to type
  PriorityCode maps to priority
  ReferralSubjectOfRecord maps to patient
  ReferralRequester maps to requester
  Recipient maps to recipient
  CareContext maps to encounter
  ReasonCode maps to reason
  ReasonReference maps to extension
  CommentOrDescription maps to description
  ServiceType maps to serviceRequested
  RelatedInformation maps to supportingInformation
  ExpectedPerformanceTime maps to fulfillmentTime
  ExpectedPerformerType maps to extension
  Annotation maps to extension

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest shr-core-ReferralRequest
... extension 1..*Slice: Unordered, Open by value:url
... shr-core-Replaces-extension 0..*Reference(shr-core-ActionRequested)Replaces
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension
.... valueReference Reference(shr-core-ReferralRequest)ReferralRequest
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... valueCodeableConcept Binding: request-intent (required)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-Annotation-extension 0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Annotation-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-ReferralRecipient-extension 0..*Reference(shr-core-Practitioner | shr-core-Organization)ReferralRecipient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRecipient-extension
... type Binding: referral-type (example)
... priority Binding: request-priority (required)
... patient 1..1Reference(shr-core-Patient)
... requester Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient)
... recipient 0..1Reference(shr-core-Practitioner | shr-core-Organization)
... encounter Reference(shr-core-Encounter)
... serviceRequested Binding: service-type (example)
... supportingInformation Reference(shr-core-DomainResource)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ReferralRequest 0..*shr-core-ReferralRequest
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 1..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-Replaces-extension 0..*Reference(shr-core-ActionRequested)Replaces
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Replaces-extension"
.... valueReference 1..1Reference(shr-core-ReferralRequest)ReferralRequest
... shr-core-RequestIntent-extension 1..1CodeableConceptRequestIntent
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension
Binding: request-intent (preferred)
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-RequestIntent-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: request-intent (required)
... shr-core-ReasonReference-extension 0..*Reference(shr-core-Condition | shr-core-Observation)ReasonReference
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReasonReference-extension
... shr-core-ExpectedPerformerType-extension 0..1CodeableConceptExpectedPerformerType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ExpectedPerformerType-extension
... shr-core-Annotation-extension 0..*AnnotationAnnotation
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Annotation-extension
... shr-core-CommunicationMethod-extension 0..1CodeableConceptCommunicationMethod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-CommunicationMethod-extension
... shr-core-ReferralRecipient-extension 0..*Reference(shr-core-Practitioner | shr-core-Organization)ReferralRecipient
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-ReferralRecipient-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | requested | active | cancelled | accepted | rejected | completed
Binding: ReferralStatus (required)
... identifier 0..*IdentifierBusiness identifier
... date Σ0..1dateTimeDate of creation/activation
... type Σ0..1CodeableConceptReferral/Transition of care request type
Binding: referral-type (example)
... specialty 0..1CodeableConceptThe clinical specialty (discipline) that the referral is requested for
Binding: PractitionerSpecialty (example)
... priority Σ0..1CodeableConceptUrgency of referral / transfer of care request
Binding: request-priority (required)
... patient Σ1..1Reference(shr-core-Patient)Patient referred to care or transfer
... requester Σ0..1Reference(shr-core-Practitioner | shr-core-Organization | shr-core-Patient)Requester of referral / transfer of care
... recipient Σ0..1Reference(shr-core-Practitioner | shr-core-Organization)Receiver of referral / transfer of care request
... encounter 0..1Reference(shr-core-Encounter)Originating encounter
... dateSent Σ0..1dateTimeDate referral/transfer of care request is sent
... reason Σ0..1CodeableConceptReason for referral / transfer of care request
Binding: (unbound) (example)
... description 0..1stringA textual description of the referral
... serviceRequested Σ0..*CodeableConceptActions requested as part of the referral
Binding: service-type (example)
... supportingInformation Σ0..*Reference(shr-core-DomainResource)Additonal information to support referral or transfer of care request
... fulfillmentTime Σ0..1PeriodRequested service(s) fulfillment time

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements