{
"description": "Conformance requirements for NHS Digital EPS NextGen APIs",
"_filename": "apim-medicines-nextgen.json",
"package_name": "uk.nhsdigital.medicines.r4",
"format": [ "application/fhir+json" ],
"date": "2021-04-28T00:00:00+00:00",
"publisher": "digital.nhs.uk",
"fhirVersion": "4.0.1",
"name": "APIMEPSNextGen",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "2.7.9",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package",
"extension": [ {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "uk.nhsdigital.r4.test"
} ]
}, {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "uk.nhsdigital.medicines.r4.test"
} ]
}, {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "UKCore.Release1.test"
}, {
"url": "version",
"valueString": "1.2.2-prerelease"
} ]
}, {
"url": "openApi",
"extension": [ {
"url": "documentation",
"valueUri": "https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir"
}, {
"url": "description",
"valueString": "Electronic Prescription Service - FHIR API"
} ]
} ]
} ],
"status": "active",
"messaging": [ {
"supportedMessage": [ {
"mode": "receiver",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/hce-DC2C66-A1B2C3-23407B"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order"
}, {
"mode": "receiver",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/homecare-update"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order-update"
}, {
"mode": "receiver",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/334a3195-1f6c-497a-8efe-d272ca9c4e38"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-notification"
}, {
"mode": "receiver",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/1e9d39ef-e999-4ab5-8fa1-bf8a0ff0ea98"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-notification-update"
} ]
} ],
"id": "0495f539-697f-4664-beb7-bca98b7c8a65",
"kind": "requirements",
"implementationGuide": [ "https://simplifier.net/guide/nhsdigital-medicine", "https://simplifier.net/guide/nhsdigital" ],
"url": "https://fhir.nhs.uk/CapabilityStatement/apim-eps-nextgen",
"version": "3.0.0",
"rest": [ {
"mode": "server",
"resource": [ {
"type": "List",
"profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-List"
}, {
"type": "Claim",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim",
"interaction": [ {
"code": "create",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Claim/258E153F-567B-4D60-B045-BA315A6B8DB0"
}
} ]
} ]
} ],
"documentation": "Use this endpoint to submit a claim for reimbursement for a dispensed prescription."
}, {
"code": "update",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Claim/258E153F-567B-4D60-B045-BA315A6B8DB0"
}
} ]
} ]
} ],
"documentation": "Use this endpoint to submit a claim for reimbursement for a dispensed prescription."
} ]
}, {
"type": "CommunicationRequest",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest"
}, {
"type": "MedicationRequest",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest"
}, {
"type": "MedicationDispense",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense"
}, {
"type": "Medication",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Medication"
}, {
"type": "Task",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task-EPS",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "required",
"valueString": "identifier"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "required",
"valueString": "foucs:identifier"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "required",
"valueString": "patient:identifier"
} ]
} ],
"operation": [ {
"name": "release",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Parameters/45a3cbe4-7688-418b-91d3-8f6d5ca94905"
}
}, {
"url": "summary",
"valueMarkdown": "Patient Pharmacy Release Request"
}, {
"url": "description",
"valueMarkdown": "`group-identifier` **MUST** be present. This is also known as the prescription token."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Parameters/ee778f88-e1aa-49b0-8cbc-77d54c65ef9e"
}
}, {
"url": "summary",
"valueMarkdown": "Nominated Pharmacy Release Request"
}, {
"url": "description",
"valueMarkdown": "`group-identifier` **MUST NOT** be present. "
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/E9DDBBC4-DA9A-C223-A2E3-909534332C69"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/Task-release-message"
} ],
"interaction": [ {
"code": "create",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/ee1b55f8-113c-4725-99a3-25fbad366dd6"
}
}, {
"url": "summary",
"valueMarkdown": "Return a prescription to spine"
}, {
"url": "description",
"valueMarkdown": "No dispense notifications may exist on spine for this action. Use withdraw dispense notification to remove them from spine."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/6a2624a2-321b-470e-91a6-8ae7a065e2f0"
}
}, {
"url": "summary",
"valueMarkdown": "Withdraw a dispense notification"
}, {
"url": "description",
"valueMarkdown": "Use this endpoint to withdraw the **last** dispense-notification message, for example in the case that a prescription was marked as dispensed erroneously."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/1291fcca-902b-48f3-9d07-1be9ea30d7a0"
}
}, {
"url": "summary",
"valueMarkdown": "Cancel a Prescription (proposed)"
}, {
"url": "description",
"valueMarkdown": "This is a proposed replacement for the prescription-order-update message."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/702cc4e9-81fc-470e-8ae1-43120ae5c16d"
}
}, {
"url": "summary",
"valueMarkdown": "Accept a Prescription (not to be implemented in NextGen)"
}, {
"url": "description",
"valueMarkdown": "This is an example of $release interaction repackaged as a RESTful interfaction."
} ]
} ]
} ],
"documentation": "Used for returns prescriptions to spine. Should be a PUT"
}, {
"code": "search-type",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/3b17d59c-41d6-44d7-81e6-47cc398e9dcc"
}
}, {
"url": "summary",
"valueMarkdown": "Patient Task/Prescription search"
}, {
"url": "description",
"valueMarkdown": "Request **GET [baseUrl]/Task?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003489"
} ]
} ]
} ],
"documentation": "The EPS Tracker"
} ],
"searchParam": [ {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "exampleParameter",
"valueString": "f28682c0-50d2-472a-a8f0-477f7ac1b63f"
} ]
} ],
"documentation": "The short form identifier of the prescription you are searching for."
}, {
"name": "focus:identifier",
"type": "token",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "exampleParameter",
"valueString": "f28682c0-50d2-472a-a8f0-477f7ac1b63f"
} ]
} ],
"documentation": "The short form identifier of the prescription you are searching for."
}, {
"name": "patient:identifier",
"type": "token",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "exampleParameter",
"valueString": "https://fhir.nhs.uk/Id/nhs-number|9000000009"
} ]
} ],
"documentation": "The NHS Number of the patient whose prescriptions you are searching for."
}, {
"name": "authored-on",
"type": "date",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "exampleParameter",
"valueString": "eq2004-09-20"
} ]
} ],
"documentation": "Date the prescription was authored"
}, {
"name": "business-status",
"type": "token",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "allowedValues",
"valueReference": {
"reference": "https://fhir.nhs.uk/ValueSet/DM-task-business-status"
}
} ]
} ],
"documentation": "The state that a prescription is in."
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
}, {
"url": "showCodeAndSystem",
"valueBoolean": false
}, {
"url": "allowedValues",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/task-status"
}
} ]
} ],
"documentation": "Search by task status"
} ]
} ],
"security": {
"service": [ {
"coding": [ {
"code": "OAuth",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "OAuth2 Token"
} ]
} ]
},
"operation": [ {
"name": "process-message",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "OperationOutcome/c9643613-0b72-4453-bfd2-71bfd2330c73"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-process-message"
}, {
"name": "verify-signature",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/155e1102-9e71-4f19-9453-b905c0bbc494"
}
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "Parameters/794e6272-a022-48f9-bcdb-867c993548da"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/verify-signature"
}, {
"name": "prepare",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Bundle/homecare-prepare"
}
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "Parameters/320b2e2a-0fa0-4ffa-ad3d-f223c27e849d"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message"
} ]
} ]
}