{
"description": "Example API Statement for NHS Digital Medicines APIs",
"_filename": "CapabilityStatement-apim-eps.json",
"package_name": "uk.nhsdigital.r4",
"format": [ "application/fhir+json", "application/fhir+xml" ],
"date": "2021-04-28T00:00:00+00:00",
"publisher": "digital.nhs.uk",
"fhirVersion": "4.0.1",
"name": "APIMEPS",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "2.11.0",
"status": "active",
"messaging": [ {
"supportedMessage": [ {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order"
}, {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order-update"
}, {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-notification"
}, {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-notification-update"
}, {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-claim"
}, {
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-claim-update"
} ]
} ],
"id": "427fbc3e-fae0-43ed-9f5f-1b13b52afc57",
"kind": "instance",
"implementationGuide": [ "https://simplifier.net/guide/digitalmedicines", "https://simplifier.net/guide/nhsdigital" ],
"url": "https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example",
"software": {
"name": "EPS NextGen",
"version": "1.2.4-alpha",
"releaseDate": "2021-07-21T00:00:00+00:00"
},
"version": "3.0.0",
"implementation": {
"description": "This is an example EPS API Capability Statement"
},
"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"
}, {
"type": "CommunicationRequest",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest"
}, {
"type": "Immunization",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Immunization",
"interaction": [ {
"code": "search-type"
} ],
"searchParam": [ {
"name": "patient:identifier",
"type": "token",
"documentation": "The patient identifier (e.g. NHS Number) that the immunisation is about"
}, {
"name": "patient",
"type": "reference",
"documentation": "The patient that the immunisation is about"
}, {
"name": "procedure:below",
"type": "token",
"definition": "https://fhir.nhs.uk/SearchParameter/procedure-code",
"documentation": "Parent snomed procedure code for vaccinations"
} ]
}, {
"type": "MedicationRequest",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest",
"interaction": [ {
"code": "search-type"
} ],
"searchParam": [ {
"name": "patient:identifier",
"type": "token",
"documentation": "Returns prescriptions for a specific patientt identifier (NHS Number)"
}, {
"name": "patient",
"type": "reference",
"documentation": "Returns prescriptions for a specific patient"
}, {
"name": "medication",
"type": "reference",
"documentation": "Return prescriptions for this medication reference"
}, {
"name": "status",
"type": "token",
"documentation": "Status of the prescription"
}, {
"name": "authoredon",
"type": "date",
"documentation": "Return prescriptions written on this date"
} ]
}, {
"type": "MedicationDispense",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense",
"interaction": [ {
"code": "search-type"
} ],
"searchParam": [ {
"name": "patient:identifier",
"type": "token",
"documentation": "TThe identity (NHS Number) of a patient to list dispenses for"
}, {
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
} ]
}, {
"type": "Medication",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Medication"
}, {
"type": "Task",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task",
"operation": [ {
"name": "release",
"definition": "https://fhir.nhs.uk/OperationDefinition/Task-release-message"
} ],
"interaction": [ {
"code": "create"
} ]
} ],
"security": {
"service": [ {
"coding": [ {
"code": "OAuth",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "OAuth2 Token"
} ]
} ]
},
"operation": [ {
"name": "process-message",
"definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-process-message"
}, {
"name": "prepare",
"definition": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message"
}, {
"name": "validate",
"definition": "http://hl7.org/fhir/OperationDefinition/Resource-validate"
} ]
} ]
}