Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Referral Details Bundle

The FHIR profiles used for the Referral details Bundle

Heading Description

The details of the individual or team who referred the woman.

The following profiles are referenced from the safety alerts details list structure:

Referral Structure Details

Page-1 PractitionerRole Resource PractitionerRole Resource PractitionerRoleResource Dynamic connector.3212 Dynamic connector.3215 Dynamic connector.3216 Organization Resource Organization Resource OrganizationResource Dynamic connector.1786 0..* R entry.item 0..* R entry.item 0..* Rentry.item 0..1 R practitioner 0..1 R practitioner 0..1 Rpractitioner 0..1 R Requester (agent) 0..1 R Requester (agent) 0..1 RRequester(agent) 0..1 R onBeHalfOf 0..1 R onBeHalfOf 0..1 RonBeHalfOf Referral Details List Resource Referral Details List Resource Referral DetailsList Resource ReferralRequest Resource ReferralRequest Resource ReferralRequestResource Practitioner Resource Practitioner Resource PractitionerResource Reference to Patient resource Reference to Patient resource Reference to Patient resource Dynamic connector.2216 1..1 M subject 1..1 M subject 1..1 Msubject

Mapping Overview

Date/Time of Referral referralRequest authoredOn
ODS/ORD Site Code   requester.onBehlafOf[organization.identifier]
Service Referred to   speciality
Source of Referral   type
Urgency   priority
Reason   reasonCode
Comment   note

Mapping for Referral List

> Level 1 List Resource > Level 2 CareConnect-List-1 Profile > Level 2 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Digital Maternity Implementation
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-List-1'
- identifier 0..* Required Identifier Business identifier
An identifier for this Social Context details list
- - system 1..1 Required Uri The namespace for the identifier value
The system from which the identifier came from
- - period 0..1 Mandatory Period Time period when id is/was valid for use
Constraint (per-1): If present, start SHALL have a lower value than end
- status 1..1 Mandatory Code current : retired : entered-in-error
Binding (required): The current state of the list ListStatus
The status of the list MUST contain the value 'current'
- mode 1..1 Mandatory Code working : snapshot : changes
Binding (required): The processing mode that applies to this list ListMode
The mode of the list MUST contain the value 'snapshot'
- title 0..1 Mandatory String Descriptive name for the list
This MUST contain the value 'Referral'
Mapping to Maternity data item = 'PSRB Heading Referral'
- code 0..1 Mandatory CodeableConcept What the purpose of this list is
Binding (preferred): What the purpose of a list is CareConnect-ListCode-1
The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set
- - coding 0..* Mandatory Coding Code defined by a terminology system
The SNOMED CT concept for the PRSB heading type
- - - system 0..1 Mandatory Uri Identity of the terminology system
This MUST contain the value 'http://snomed.info/sct'
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
This MUST contain the value '3457005'
- - - display 0..1 Mandatory String Representation defined by the system
Mapping to Maternity data item = 'PSRB Heading Referral'
- subject 0..1 Mandatory Reference If all resources have the same subject
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
This is a reference to the Patient who is the subject of the list.
    Mandatory CareConnect-Patient-1 This is the subject of the referral details List. This MUST use the CareConnect patient profile.See patient resource reference for information on how to populate the resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle
- date 0..1 Required dateTime When the list was prepared
This MUST contain a system date to indicate when the list was created or updated
- entry 0..* Required BackboneElement Entries in the list
The entries MUST be as per the diagram for this PRSB headings list with the referralrequest resource being the focal resource.
- - date 0..1 Required dateTime When item added to list
The SHOULD contain a system time of when the item was added to the list.
- - item 1..1 Mandatory Reference Actual entry
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
A reference to an Encounter resource included in the list This MUST use the CareConnect referralRequest profile.
- - - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL

Patient Reference

The Plan and requested actions List has a mandated subject reference to the Patient resource. This means that any exchange of the Plan and requested actions heading data must also include the Patient demographics List.

Mapping for Referral

> Level 1 ReferralRequest Resource > Level 2 CareConnect-ReferralRequest-1 Profile > Level 3 None
View Used FHIR Elements View All FHIR Elements
Name Card. Conformance Type Description, Constraints and mapping for Digital Maternity Implementation
- id 0..1 Optional Id Logical id of this artifact
- meta 0..1 Mandatory Meta Metadata about the resource
The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-ReferralRequest-1'
- identifier 0..* Required Identifier Business identifier
An identifier for this Referral Request
- - system 0..1 Required Uri The namespace for the identifier value
- - value 0..1 Mandatory String The value that is unique
- type 0..1 Required CodeableConcept Referral/Transition of care request type
Binding (example): Codes for types of referral; e.g. consult, transfer, temporary transfer. (http://hl7.org/fhir/stu3/valueset-referral-type.html )
A classification which identifies the source of referral
- priority 0..1 Required Code Urgency of referral / transfer of care request
Binding (required): Codes indicating the relative priority of the referral. ( http://hl7.org/fhir/stu3/valueset-request-priority.html )
This is the priority of a request for services
- subject 0..1 Mandatory Reference If all resources have the same subject
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
This is a reference to the Patient who is the subject of the list.
    Mandatory CareConnect-Patient-1 This is the subject of the referral details List. This MUST use the CareConnect patient profile.See patient resource reference for information on how to populate the resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL
A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle
- authoredOn 0..1 Mandatory dateTime Date of creation/activation
The date the Referral was made
- - onBehalfOf 0..1 Required Reference Organization agent is acting for
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
    Mandatory CareConnect-Organization-1
This MUST use the CareConnect Organization profile.See Organization resource reference for information on how to populate this resource.
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URLA reference to the Organization resource included in the referral list
- specialty 0..1 Mandatory CodeableConcept The clinical specialty (discipline) that the referral is requested for
Binding (example): Codes indicating the types of capability the referred to service provider must have. (http://hl7.org/fhir/stu3/valueset-practitioner-specialty.html )
- - coding 0..* Mandatory Coding Code defined by a terminology system
- - - system 0..1 Mandatory Uri Identity of the terminology system
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - display 0..1 Mandatory String Representation defined by the system
- - text 0..1 Optional String Plain text representation of the concept
- reasonCode 0..* Mandatory CodeableConcept Reason for referral / transfer of care request
Binding (example): Codes indicating why the referral is being requested. ( http://hl7.org/fhir/stu3/valueset-clinical-findings.html )
Reason for Referral
- - coding 0..* Mandatory Coding Code defined by a terminology system
- - - system 0..1 Mandatory Uri Identity of the terminology system
- - - code 0..1 Mandatory Code Symbol in syntax defined by the system
- - - display 0..1 Mandatory String Representation defined by the system
- - text 0..1 Optional String Plain text representation of the concept
- note 0..* Optional Annotation Comments made about referral request
Comment related to referral
- - author[x] 0..1 Required String Individual responsible for the annotation
Constraint (ref-1): SHALL have a contained resource if a local reference is provided
- - reference 0..1 Mandatory String Literal reference, Relative, internal or absolute URL A reference to the Patient, RelatedPerson or Practitioner
    Optional CareConnect-Patient-1
This MUST use the CareConnect Patient profile.See Patient resource reference for information on how to populate these resources.
    Optional CareConnect-RelatedPerson-1
This MUST use the CareConnect RelatedPerson profile.See RelatedPerson resource reference
    Optional CareConnect-Practitioner-1
This MUST use the CareConnect-Prctitioner profile.See Practitioner resource referencefor information on how to populate these resources.

Mapping for Plan and Requested Actions Practitioner

The plan and requested actions details has reference(s) to the Practitioner resource. This means that any exchange of the plan and requested actions details heading data must also include the Practitioner Details

Mapping for Plan and Requested Actions PractitionerRole

The plan and requested actions details has reference(s) to the Practitioner Role resource. This means that any exchange of the plan and requested actions details heading data must also include the Practitioner Role Details

Mapping for Referral Request Organisation

The referral request details has reference(s) to the Organization resource. This means that any exchange of the referral request details heading data must also include the Organization Details

Referral Example

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated