FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/apim-medicines-api-example

Packageuk.nhsdigital.r4.test
Resource TypeCapabilityStatement
Idapim-medicines-api-example
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=uk.nhsdigital.r4.test@2.16.0-prerelease&canonical=https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example
URLhttps://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example
Version3.0.0
Statusactive
Date2021-04-28T00:00:00+00:00
NameAPIMEPS
DescriptionExample API Statement for NHS Digital Medicines APIs
Kindinstance

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
digitalmedicinesNHS Digital FHIR Medicines (Retired - 2.1.14)
OperationDefinition
MessageHeader-prepare-messageMessageheaderPrepareMessage
MessageHeader-process-messageProcessMessage
Task-release-messageReleaseTask
SearchParameter
procedure-codeProcedureCode
StructureDefinition
NHSDigital-CommunicationRequestNHSDigital-CommunicationRequest
NHSDigital-ClaimNHSDigitalClaim
NHSDigital-ImmunizationNHSDigitalImmunization
NHSDigital-MedicationNHS Digital Medication
NHSDigital-MedicationDispenseNHS Digital MedicationDispense
NHSDigital-MedicationRequestNHS Digital MedicationRequest
NHSDigital-TaskNHS Digital Task

Narrative

No narrative content found in resource


Source

{
  "resourceType": "CapabilityStatement",
  "id": "apim-medicines-api-example",
  "url": "https://fhir.nhs.uk/CapabilityStatement/apim-medicines-api-example",
  "version": "3.0.0",
  "name": "APIMEPS",
  "status": "active",
  "date": "2021-04-28T00:00:00+00:00",
  "publisher": "digital.nhs.uk",
  "description": "Example API Statement for NHS Digital Medicines APIs",
  "kind": "instance",
  "software": {
    "name": "EPS NextGen",
    "version": "1.2.4-alpha",
    "releaseDate": "2021-07-21T00:00:00+00:00"
  },
  "implementation": {
    "description": "This is an example EPS API Capability Statement"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "implementationGuide": [
    "https://simplifier.net/guide/digitalmedicines",
    "https://simplifier.net/guide/nhsdigital"
  ],
  "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",
              "definition": "https://fhir.nhs.uk/SearchParameter/procedure-code",
              "type": "token",
              "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",
          "interaction": [
            {
              "code": "create"
            }
          ],
          "operation": [
            {
              "name": "release",
              "definition": "https://fhir.nhs.uk/OperationDefinition/Task-release-message"
            }
          ]
        }
      ],
      "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"
        }
      ]
    }
  ],
  "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"
        }
      ]
    }
  ]
}