{
"description": "Conformance requirements for NHS Digital EPS Futures",
"_filename": "apim-medicines-futures.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": "APIMEPSFutures",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "2.7.1",
"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",
"id": "d5786ee2-d13e-4662-9d2a-23094e4107aa",
"kind": "requirements",
"implementationGuide": [ "https://simplifier.net/guide/nhsdigital-medicine", "https://simplifier.net/guide/nhsdigital" ],
"url": "https://fhir.nhs.uk/CapabilityStatement/apim-eps-futures",
"version": "3.0.0",
"rest": [ {
"mode": "server",
"resource": [ {
"type": "MedicationRequest",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest-Contained",
"operation": [ {
"name": "lock",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/702cc4e9-81fc-470e-8ae1-43120ae5c16d"
}
}, {
"url": "summary",
"valueMarkdown": "Dispenser accepts a MedicationRequest assigned to them or takes ownership and accepts a MedicationRequest"
}, {
"url": "description",
"valueMarkdown": "Task.status is set to accepted and the owner field must be populated."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "OperationOutcome/option2"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/MedicationRequest-lock"
}, {
"name": "unlock",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/af8a007d-0a7c-4124-a713-55280eaaf5bb"
}
}, {
"url": "summary",
"valueMarkdown": "Dispenser completes fullfilment of order"
}, {
"url": "description",
"valueMarkdown": "Task.status set to completed."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/148fd3a7-79e1-4bee-b769-cc6ada05391d"
}
}, {
"url": "summary",
"valueMarkdown": "Dispenser rejects MedicationRequest assigned to them"
}, {
"url": "description",
"valueMarkdown": "Task.status set to rejected and a statusReason is given (e.g. unable to dispense medications)"
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/04908e21-1c70-4cc8-ac7b-1e611eddae1e"
}
}, {
"url": "summary",
"valueMarkdown": "Dispenser fails MedicationRequest assigned or previously accepted by them"
}, {
"url": "description",
"valueMarkdown": "Task.status set to rejected and a reason is given (e.g. invalid digital signature)"
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/1291fcca-902b-48f3-9d07-1be9ea30d7a0"
}
}, {
"url": "summary",
"valueMarkdown": "Dispenser or other practitioner cancels the MedicationRequest"
}, {
"url": "description",
"valueMarkdown": "Task.status set to cancelled or entered-in-error."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "OperationOutcome/option2"
}
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/MedicationRequest-unlock"
} ],
"interaction": [ {
"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/fc2af095-2074-473c-b527-701a74998773"
}
}, {
"url": "summary",
"valueMarkdown": "Patient MedicationRequest search"
}, {
"url": "description",
"valueMarkdown": "Request **GET [baseUrl]/MedicationRequest?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888"
} ]
} ]
} ],
"documentation": "The EPS Tracker."
}, {
"code": "read",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "MedicationRequest/a7b86f8d-1d7c-fc28-e050-d20ae3a215f4"
}
} ]
} ]
} ],
"documentation": "**Download prescription (part)**"
}, {
"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": "MedicationRequest/a7b86f8d-1d7c-fc28-e050-d20ae3a215f4"
}
} ]
} ]
} ],
"documentation": "**Create a new prescription**. Equivalent to `prescription-order` message in NextGen"
}, {
"code": "patch",
"documentation": "Replaces part of the functionality in cancel prescription"
} ],
"searchParam": [ {
"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": "Returns prescriptions for a specific patient"
}, {
"name": "intended-performer",
"type": "reference",
"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/ods-organization-code|M85011"
} ]
} ],
"documentation": "Return prescriptions for this medication reference"
}, {
"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/medicationrequest-status"
}
} ]
} ],
"documentation": "Status of the prescription"
}, {
"name": "requester.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/ods-organization-code|M85011"
} ]
} ],
"documentation": "Returns prescriptions prescribed by this prescriber"
}, {
"name": "group",
"type": "reference",
"documentation": "Returns grouped prescriptions"
}, {
"name": "_count",
"type": "special",
"documentation": "How many results to return"
} ]
}, {
"type": "MedicationDispense",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense",
"interaction": [ {
"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/11c0abb3-7223-4cd8-88bd-68d29694f24c"
}
}, {
"url": "summary",
"valueMarkdown": "Patient MedicationDispense search"
}, {
"url": "description",
"valueMarkdown": "Request **GET [baseUrl]/MedicationDispense?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9912003888"
} ]
} ]
} ],
"documentation": "EPS Tracker."
}, {
"code": "read",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples",
"extension": [ {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": false
}, {
"url": "value",
"valueReference": {
"reference": "MedicationDispense/06167339-9337-d030-0366-514a6a46da17"
}
} ]
} ]
} ],
"documentation": "New feature. Allows querying of a patients dispense history"
}, {
"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": "MedicationDispense/06167339-9337-d030-0366-514a6a46da17"
}
} ]
} ]
} ],
"documentation": "**Mark a prescription as Dispensed**. Equivalent to `dispense-notification` in NextGen"
}, {
"code": "patch"
} ],
"searchParam": [ {
"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 identity of a patient to list dispenses for"
}, {
"name": "prescription",
"type": "reference",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-QueryParameters",
"extension": [ {
"url": "minimum",
"valueInteger": 0
}, {
"url": "maximum",
"valueInteger": 1
} ]
} ],
"documentation": "The identity of a prescription to list dispenses from"
}, {
"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/medicationdispense-status"
}
} ]
} ],
"documentation": "Returns dispenses with a specified dispense status"
}, {
"name": "_count",
"type": "special",
"documentation": "How many results to return"
} ]
} ],
"security": {
"service": [ {
"coding": [ {
"code": "OAuth",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "OAuth2 Token"
} ]
} ]
}
} ]
}