NHS Digital FHIR Medicines (Retired - 2.1.14)

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

CapabilityStatement

instance

Profile uri
https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example

FHIR RESTful

Could not find subject. Resource was not found for 'canonical=https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example'

FHIR Messaging

Mode Supported Messages
receiver prescription-order
receiver prescription-order-update
receiver prescription-order-response
receiver dispense-notification
Command 'json' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example'
Command 'xml' could not render: Resource was not found for 'canonical=https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example'

requirements

Profile uri
https://fhir.nhs.uk/CapabilityStatement/apim-medicines-conformance

FHIR RESTful

REST Capabilities Server

ModeServer

Security

ServiceOAuth2 Token

Resource Interactions

Resource TypeProfileSupported ProfilesSearchTypeCreate
List
Claim
CommunicationRequesthttps://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest
Immunization✓
MedicationRequest✓
MedicationDispense✓
Medication
Task✓

Global Operations

OperationReferenceLevel
process-messageProcess MessageSupported
prepareSupported
validateValidate a resourceSupported

Operations per resource type

List

No operations are stated for this resource type

Claim

No operations are stated for this resource type

CommunicationRequest

No operations are stated for this resource type

Immunization

No operations are stated for this resource type

MedicationRequest

No operations are stated for this resource type

MedicationDispense

No operations are stated for this resource type

Medication

No operations are stated for this resource type

Task

OperationReferenceLevel
releaseSupported

Search Parameters per resource type

List

No search parameters are stated for this resource type

Claim

No search parameters are stated for this resource type

CommunicationRequest

No search parameters are stated for this resource type

Immunization

NameTypeDocumentationLevel
patient:identifiertoken

The patient identifier (e.g. NHS Number) that the immunisation is about

Supported
patientreference

The patient that the immunisation is about

Supported
procedure:belowtoken

Parent snomed procedure code for vaccinations

Supported

MedicationRequest

NameTypeDocumentationLevel
patient:identifiertoken

Returns prescriptions for a specific patientt identifier (NHS Number)

Supported
patientreference

Returns prescriptions for a specific patient

Supported

MedicationDispense

NameTypeDocumentationLevel
patient:identifiertoken

TThe identity (NHS Number) of a patient to list dispenses for

Supported
patientreference

TThe identity of a patient to list dispenses for

Supported

Medication

No search parameters are stated for this resource type

Task

No search parameters are stated for this resource type

Messaging Capabilities

Endpoints
ProtocolAddress
Supported Messages
ModeDefinition
Receiver
Receiver
Receiver
Receiver
Receiver
Receiver
Receiver

FHIR Messaging

Mode Supported Messages
receiver prescription-order
receiver prescription-order-update
receiver prescription-order-response
receiver dispense-notification
{
"resourceType": "CapabilityStatement",
"id": "apim-medicines-conformance",
"url": "https://fhir.nhs.uk/CapabilityStatement/apim-medicines-conformance",
"version": "3.0.0",
"name": "NHS Digital Medicines Capability Statement",
"status": "active",
"date": "2021-04-28T00:00:00+00:00",
"publisher": "digital.nhs.uk",
"description": "Conformance requirements for NHS Digital Medicines APIs",
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"application/fhir+json",
"application/fhir+xml"
],
"rest": [
{
"mode": "server",
"security": {
"service": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "OAuth",
"display": "OAuth2 Token"
}
]
}
]
},
"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"
}
]
},
{
"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": "TThe identity of a patient to list dispenses for"
}
]
},
{
"type": "Medication",
"profile": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication"
},
{
"type": "Task",
"profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task",
"interaction": [
{
"code": "create"
}
],
"operation": [
{
"name": "release",
"definition": "https://fhir.nhs.uk/OperationDefinition/Task-release-message"
}
]
}
],
"operation": [
{
"name": "process-message",
"definition": "http://hl7.org/fhir/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"
}
]
}
],
"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/pharmacy-dispense"
},
{
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-claim"
},
{
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/vaccinations"
},
{
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order-response"
},
{
"mode": "receiver",
"definition": "https://fhir.nhs.uk/MessageDefinition/dispense-claim-update"
}
]
}
]
}
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="apim-medicines-conformance" />
<url value="https://fhir.nhs.uk/CapabilityStatement/apim-medicines-conformance" />
<version value="3.0.0" />
<name value="NHS Digital Medicines Capability Statement" />
<status value="active" />
<date value="2021-04-28T00:00:00+00:00" />
<publisher value="digital.nhs.uk" />
<description value="Conformance requirements for NHS Digital Medicines APIs" />
<kind value="requirements" />
<fhirVersion value="4.0.1" />
<format value="application/fhir+json" />
<format value="application/fhir+xml" />
<rest>
<mode value="server" />
<security>
<service>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/restful-security-service" />
<code value="OAuth" />
<display value="OAuth2 Token" />
</coding>
</service>
</security>
<resource>
<type value="List" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-List" />
</resource>
<resource>
<type value="Claim" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Claim" />
</resource>
<resource>
<type value="CommunicationRequest" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest" />
</resource>
<resource>
<type value="Immunization" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Immunization" />
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="patient:identifier" />
<type value="token" />
<documentation value="The patient identifier (e.g. NHS Number) that the immunisation is about" />
</searchParam>
<searchParam>
<name value="patient" />
<type value="reference" />
<documentation value="The patient that the immunisation is about" />
</searchParam>
<searchParam>
<name value="procedure:below" />
<definition value="https://fhir.nhs.uk/SearchParameter/procedure-code" />
<type value="token" />
<documentation value="Parent snomed procedure code for vaccinations" />
</searchParam>
</resource>
<resource>
<type value="MedicationRequest" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationRequest" />
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="patient:identifier" />
<type value="token" />
<documentation value="Returns prescriptions for a specific patientt identifier (NHS Number)" />
</searchParam>
<searchParam>
<name value="patient" />
<type value="reference" />
<documentation value="Returns prescriptions for a specific patient" />
</searchParam>
</resource>
<resource>
<type value="MedicationDispense" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-MedicationDispense" />
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="patient:identifier" />
<type value="token" />
<documentation value="TThe identity (NHS Number) of a patient to list dispenses for" />
</searchParam>
<searchParam>
<name value="patient" />
<type value="reference" />
<documentation value="TThe identity of a patient to list dispenses for" />
</searchParam>
</resource>
<resource>
<type value="Medication" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Medication" />
</resource>
<resource>
<type value="Task" />
<profile value="https://fhir.nhs.uk/StructureDefinition/NHSDigital-Task" />
<interaction>
<code value="create" />
</interaction>
<operation>
<name value="release" />
<definition value="https://fhir.nhs.uk/OperationDefinition/Task-release-message" />
</operation>
</resource>
<operation>
<name value="process-message" />
<definition value="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message" />
</operation>
<operation>
<name value="prepare" />
<definition value="https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message" />
</operation>
<operation>
<name value="validate" />
<definition value="http://hl7.org/fhir/OperationDefinition/Resource-validate" />
</operation>
</rest>
<messaging>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/prescription-order" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/prescription-order-update" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/pharmacy-dispense" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/dispense-claim" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/vaccinations" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/prescription-order-response" />
</supportedMessage>
<supportedMessage>
<mode value="receiver" />
<definition value="https://fhir.nhs.uk/MessageDefinition/dispense-claim-update" />
</supportedMessage>
</messaging>
</CapabilityStatement>
back to top