{
  "description": null,
  "_filename": "NHSDigital-CommunicationRequest.StructureDefinition.json",
  "package_name": "uk.nhsdigital.r4.test",
  "date": null,
  "derivation": "constraint",
  "publisher": null,
  "fhirVersion": "4.0.1",
  "name": "NHSDigitalCommunicationRequest",
  "mapping": [ {
    "uri": "http://hl7.org/fhir/workflow",
    "name": "Workflow Pattern",
    "identity": "workflow"
  }, {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "CommunicationRequest",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": null,
  "package_version": "2.8.13-prerelease",
  "status": "draft",
  "id": "b3093a43-5505-437d-8555-df95807634b8",
  "kind": "resource",
  "url": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest",
  "version": null,
  "differential": {
    "element": [ {
      "id": "CommunicationRequest.status",
      "path": "CommunicationRequest.status",
      "mustSupport": true
    }, {
      "id": "CommunicationRequest.medium",
      "path": "CommunicationRequest.medium",
      "binding": {
        "strength": "extensible",
        "valueSet": "https://fhir.nhs.uk/ValueSet/Spine-CommunicationChannel-vs"
      }
    }, {
      "id": "CommunicationRequest.subject",
      "path": "CommunicationRequest.subject",
      "type": [ {
        "code": "Reference",
        "aggregation": [ "referenced" ],
        "targetProfile": [ "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient" ]
      } ],
      "constraint": [ {
        "key": "patient-reference",
        "human": "subject - An identifier reference or resource reference must be provided",
        "source": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest",
        "severity": "warning",
        "expression": "(reference.exists() or (identifier.exists()))"
      }, {
        "key": "patient-nhs",
        "human": "Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.",
        "source": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest",
        "severity": "error",
        "expression": "identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists()  and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))"
      } ],
      "definition": "The patient or group that is the focus of this communication request.\r\n\r\n```json\r\n\"subject\": {\r\n        \"type\": \"Patient\",\r\n        \"identifier\": {\r\n            \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\r\n            \"value\": \"9453740519\"\r\n        }\r\n    }\r\n```",
      "mustSupport": true
    }, {
      "id": "CommunicationRequest.subject.identifier.system",
      "min": 1,
      "path": "CommunicationRequest.subject.identifier.system"
    }, {
      "id": "CommunicationRequest.subject.identifier.value",
      "min": 1,
      "path": "CommunicationRequest.subject.identifier.value"
    }, {
      "id": "CommunicationRequest.payload",
      "min": 1,
      "path": "CommunicationRequest.payload",
      "comment": "The payload will consist of message to the Patient and/or a reference to a list of active repeat medications.",
      "definition": "#### NHSApp\r\n\r\n**In App Messages** \r\n\r\nNHSApp supports a subset of Markdown for in-app messages, please see API documentation for more details. Only `contentString` is supported.\r\n\r\n```json\r\n  \r\n    \"payload\":  [\r\n        {\r\n            \"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)\"\r\n        }\r\n    ]\r\n```\r\n\r\n**Push Notifications**\r\n\r\nOnly `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.\r\n\r\n```json\r\n  \r\n    \"payload\":  [\r\n        {\r\n            \"contentReference\": {\r\n                \"reference\": \"https://www.nhsapp.service.nhs.uk/patient/messages/app-messaging\",\r\n                \"display\": \"You have a new message. The message may contain something important.\"\r\n            }\r\n        }\r\n    ],\r\n```\r\n\r\n#### EPS\r\n\r\n**CommunicationRequest** is used in Electronic Prescription Service (EPS) to convey patient specific information. This includes:\r\n\r\n* patient information - messages to the patient\r\n* 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`\r\n\r\nThese would be traditionally printed on the right hand side of the FP10 stationery.\r\n\r\n**CommunicationRequest should not contain Clinical information regarding the prescriptions, these should be conveyed in the MedicationRequest resource.**\r\n\r\n```json\r\n\r\n    \"payload\":  [\r\n        {\r\n            \"contentString\": \"Please make an appointment to see your GP. Review date due\"\r\n        },\r\n        {\r\n            \"contentReference\": {\r\n                \"reference\": \"urn:uuid:d0f003a0-8763-43d5-a264-ce52a38901c9\",\r\n                \"display\": \"List of Repeat Medications for re-ordering\"\r\n            }\r\n        }\r\n    ],\r\n```",
      "mustSupport": true
    }, {
      "id": "CommunicationRequest.payload.extension",
      "min": 0,
      "path": "CommunicationRequest.payload.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "CommunicationRequest.payload.extension:deviceContent",
      "max": "1",
      "min": 0,
      "path": "CommunicationRequest.payload.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-Spine-CommunicationPayload" ]
      } ],
      "sliceName": "deviceContent"
    }, {
      "id": "CommunicationRequest.requester",
      "min": 1,
      "path": "CommunicationRequest.requester",
      "type": [ {
        "code": "Reference",
        "aggregation": [ "referenced" ],
        "targetProfile": [ "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization" ]
      } ],
      "definition": "The person/organisation making the communication request. This **SHOULD** use reference identifiers.\r\n\r\n```json\r\n\r\n    \"requester\": {\r\n        \"type\": \"Organization\",\r\n        \"identifier\": {\r\n            \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n            \"value\": \"RBA\"\r\n        },\r\n        \"display\": \"TAUNTON AND SOMERSET NHS FOUNDATION TRUST\"\r\n    },\r\n```",
      "mustSupport": true
    }, {
      "id": "CommunicationRequest.requester.identifier.system",
      "min": 1,
      "path": "CommunicationRequest.requester.identifier.system"
    }, {
      "id": "CommunicationRequest.requester.identifier.value",
      "min": 1,
      "path": "CommunicationRequest.requester.identifier.value"
    }, {
      "id": "CommunicationRequest.recipient",
      "min": 1,
      "path": "CommunicationRequest.recipient",
      "type": [ {
        "code": "Reference",
        "aggregation": [ "referenced" ],
        "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/CareTeam", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Patient", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Practitioner", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-PractitionerRole", "https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService" ]
      } ],
      "definition": "The persons/organisations who will receive the communication request. This **SHOULD** use reference identifiers.\r\n\r\n```json\r\n\r\n    \"recipient\":  [\r\n        {\r\n            \"type\": \"Patient\",\r\n            \"identifier\": {\r\n                \"system\": \"https://fhir.nhs.uk/Id/nhs-number\",\r\n                \"value\": \"9453740519\"\r\n            }\r\n        }\r\n    ]\r\n```",
      "mustSupport": true
    }, {
      "id": "CommunicationRequest.recipient.identifier.system",
      "min": 1,
      "path": "CommunicationRequest.recipient.identifier.system"
    }, {
      "id": "CommunicationRequest.recipient.identifier.value",
      "min": 1,
      "path": "CommunicationRequest.recipient.identifier.value"
    }, {
      "id": "CommunicationRequest.sender.identifier.system",
      "min": 1,
      "path": "CommunicationRequest.sender.identifier.system"
    }, {
      "id": "CommunicationRequest.sender.identifier.value",
      "min": 1,
      "path": "CommunicationRequest.sender.identifier.value"
    }, {
      "id": "CommunicationRequest.reasonCode",
      "path": "CommunicationRequest.reasonCode",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.nhs.uk/ValueSet/NHSDigital-message-events",
        "description": "UKCore event types"
      }
    }, {
      "id": "CommunicationRequest.reasonCode.coding.system",
      "min": 1,
      "path": "CommunicationRequest.reasonCode.coding.system"
    }, {
      "id": "CommunicationRequest.reasonCode.coding.code",
      "min": 1,
      "path": "CommunicationRequest.reasonCode.coding.code"
    }, {
      "id": "CommunicationRequest.reasonCode.coding.display",
      "min": 1,
      "path": "CommunicationRequest.reasonCode.coding.display"
    } ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}