NHSDigital-CommunicationRequest

Conformance url FHIR Module Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest} trial-use




identifierΣ0..*Identifier
basedOnΣ I0..*Reference(Resource)
replacesΣ I0..*Reference(CommunicationRequest)
groupIdentifierΣ0..1Identifier
statusS Σ ?!1..1codeBinding
statusReason0..1CodeableConcept
category0..*CodeableConcept
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
medium0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
aboutI0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
deviceContentI0..1Extension(Complex)
contentStringstring
contentAttachmentAttachment
contentReferenceReference(Resource)
occurrenceDateTimedateTime
occurrencePeriodPeriod
authoredOnΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
note0..*Annotation

identifierΣ0..*Identifier
basedOnΣ I0..*Reference(Resource)
replacesΣ I0..*Reference(CommunicationRequest)
groupIdentifierΣ0..1Identifier
statusS Σ ?!1..1codeBinding
statusReason0..1CodeableConcept
category0..*CodeableConcept
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
medium0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
aboutI0..*Reference(Resource)
encounterΣ I0..1Reference(Encounter)
deviceContentI0..1Extension(Complex)
contentStringstring
contentAttachmentAttachment
contentReferenceReference(Resource)
occurrenceDateTimedateTime
occurrencePeriodPeriod
authoredOnΣ0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
reasonReferenceΣ I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)
note0..*Annotation
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.
  • Command 'pagelink' could not render: Page not found.



Definition

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

status

Element Id CommunicationRequest.status
Cardinality 1..1
Terminology Binding RequestStatus (Required)
The status of the communication request.
type code

Definition

The status of the proposal or order.

subject

Element Id CommunicationRequest.subject
Cardinality 0..1
type Reference(NHSDigitalPatient)

Definition

The patient or group that is the focus of this communication request.

"subject": {
        "type": "Patient",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9453740519"
        }
    }

Constraints

  • patient-reference (WARNING) subject - An identifier reference or resource reference must be provided
  • patient-nhs (ERROR) Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.

payload

Element Id CommunicationRequest.payload
Cardinality 1..*
type BackboneElement

Definition

NHSApp

In App Messages

NHSApp supports a subset of Markdown for in-app messages, please see API documentation for more details. Only contentString is supported.

  
    "payload":  [
        {
            "contentString": "You have a new appointment, please confirm you can attend. Open the Onboarded Third Party appointment [here](https://www.nhsapp.service.nhs.uk/appointments/hospital-appointments)"
        }
    ]

Push Notifications

Only contentReference is supported and this should contain the URL to a page within the NHS App to be opened when the notification is tapped. If this property is not specified, the App will open on the home screen.

  
    "payload":  [
        {
            "contentReference": {
                "reference": "https://www.nhsapp.service.nhs.uk/patient/messages/app-messaging",
                "display": "You have a new message. The message may contain something important."
            }
        }
    ],

EPS

CommunicationRequest is used in Electronic Prescription Service (EPS) to convey patient specific information. This includes:

  • patient information - messages to the patient
  • medications - list of authorised repeat medications which is contained on a FHIR List resource, details and example list of repeat medications can be found in profile UKCore-List

These would be traditionally printed on the right hand side of the FP10 stationery.

CommunicationRequest should not contain Clinical information regarding the prescriptions, these should be conveyed in the MedicationRequest resource.


    "payload":  [
        {
            "contentString": "Please make an appointment to see your GP. Review date due"
        },
        {
            "contentReference": {
                "reference": "urn:uuid:d0f003a0-8763-43d5-a264-ce52a38901c9",
                "display": "List of Repeat Medications for re-ordering"
            }
        }
    ],

Comment

The payload will consist of message to the Patient and/or a reference to a list of active repeat medications.

requester

Element Id CommunicationRequest.requester
Cardinality 1..1
type Reference(NHSDigitalPatient NHSDigitalPractitionerRole NHSDigitalOrganization)

Definition

The person/organisation making the communication request. This SHOULD use reference identifiers.


    "requester": {
        "type": "Organization",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RBA"
        },
        "display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
    },

recipient

Element Id CommunicationRequest.recipient
Cardinality 1..*
type Reference(Group CareTeam NHSDigitalOrganization NHSDigitalPatient NHSDigitalPractitioner NHSDigitalPractitionerRole NHSDigitalHealthcareService)

Definition

The persons/organisations who will receive the communication request. This SHOULD use reference identifiers.


    "recipient":  [
        {
            "type": "Patient",
            "identifier": {
                "system": "https://fhir.nhs.uk/Id/nhs-number",
                "value": "9453740519"
            }
        }
    ]