{
"description": "Conformance requirements for NHS Digital EPS Facade API",
"_filename": "apim-medicines-facade.json",
"package_name": "uk.nhsdigital.medicines.r4.test",
"format": [ "application/fhir+json" ],
"date": "2022-11-07T00:00:00+00:00",
"publisher": "digital.nhs.uk",
"fhirVersion": "4.0.1",
"name": "APIMMedicinesFacade",
"type": null,
"experimental": "true",
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "2.8.16-prerelease",
"extension": [ {
"url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package",
"extension": [ {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "uk.nhsdigital.r4"
} ]
}, {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "uk.nhsdigital.medicines.r4"
} ]
}, {
"url": "FHIRPackage",
"extension": [ {
"url": "name",
"valueString": "fhir.r4.ukcore.stu1"
}, {
"url": "version",
"valueString": "0.5.1"
} ]
}, {
"url": "openApi",
"extension": [ {
"url": "documentation",
"valueUrl": "https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir"
}, {
"url": "description",
"valueString": "Electronic Prescription Service - FHIR API"
} ]
} ]
} ],
"status": "draft",
"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/30d65c8e-98e8-4806-b6a6-51e94733f0e9"
}
}, {
"url": "description",
"valueMarkdown": "A valid secondary care prescription-order message."
} ]
} ]
} ],
"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/0a1fd9ef-a3d5-4e95-84cd-552070a03086"
}
}, {
"url": "description",
"valueMarkdown": "A valid secondary care prescription-order-update message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messageprescription-order-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/166f1103-3r67-73dw-7364-s395c4itv284"
}
}, {
"url": "description",
"valueMarkdown": "A valid secondary care dispense-notification message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messagedispense-notification)."
} ]
} ]
} ],
"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": "166726bc-922b-4b5a-a1ad-442530420185",
"kind": "requirements",
"implementationGuide": [ "https://simplifier.net/guide/nhsdigital-medicine", "https://simplifier.net/guide/nhsdigital" ],
"url": "https://fhir.nhs.uk/CapabilityStatement/apim-medicines-facade",
"version": "0.1.0",
"rest": [ {
"mode": "server",
"resource": [ {
"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": "description",
"valueMarkdown": "A valid secondary care Claim message. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Claim)."
}, {
"url": "value",
"valueReference": {
"reference": "Claim/e8e75676-9d30-45f8-8b09-696818e7f4ca"
}
} ]
} ]
} ],
"documentation": "Claim for a dispensed prescription - Dispensing"
} ]
}, {
"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": "focus:identifier"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "required",
"valueString": "patient:identifier"
} ]
} ],
"operation": [ {
"name": "prescription-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": "description",
"valueMarkdown": "A valid release request. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/OperationDefinitionrelease)."
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/prescription-release"
} ],
"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 downloaded prescription - Dispensing"
}, {
"url": "description",
"valueMarkdown": "A valid request to return a prescription. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Task)."
} ]
}, {
"url": "example",
"extension": [ {
"url": "request",
"valueBoolean": true
}, {
"url": "value",
"valueReference": {
"reference": "Task/6a2624a2-321b-470e-91a6-8ae7a065e2f0"
}
}, {
"url": "summary",
"valueMarkdown": "Withdraw a dispense notification - Dispensing"
}, {
"url": "description",
"valueMarkdown": "A valid request to withdraw a dispense notification. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Task)."
} ]
} ]
} ],
"documentation": "Return a downloaded prescription or withdraw a dispense notification"
}, {
"code": "search-type",
"documentation": "Search for summary details about a prescription"
} ],
"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"
} ],
"documentation": "Download prescription, return a downloaded prescription, withdraw a dispense notification or search for summary details about a prescription"
} ],
"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": "Bundle/30d65c8e-98e8-4806-b6a6-51e94733f0e9"
}
}, {
"url": "description",
"valueMarkdown": "A valid secondary care prescription-order message."
} ]
} ]
} ],
"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": "description",
"valueMarkdown": "A valid signature verification request."
} ]
} ]
} ],
"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/aef77afb-7e3c-427a-8657-2c427f71a271"
}
}, {
"url": "description",
"valueMarkdown": "A valid secondary care prepare request. More examples of this message can be found [here](https://simplifier.net/guide/NHSDigital-Medicines/Home/Examples/AllExamples?version=current#Home/Examples/AllExamples/Messageprescription-order)."
} ]
} ]
} ],
"definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message"
} ]
} ]
}