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

FHIR IG Statistics: OperationDefinition/prescription-release

Packageuk.nhsdigital.r4.test
Resource TypeOperationDefinition
Idprescription-release
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=uk.nhsdigital.r4.test@2.16.0-prerelease&canonical=https://fhir.nhs.uk/OperationDefinition/prescription-release
URLhttps://fhir.nhs.uk/OperationDefinition/prescription-release
Version4.0.1
Statusdraft
Date2022-10-17T11:39:00+00:00
NamePrescriptionRelease
DescriptionUse this operation to download prescriptions from Spine before it is dispensed. You can download a single prescription using the prescription's ID, or download up to 25 prescriptions (per request) nominated to a dispenser using the dispenser's ODS code. The operation will return prescriptions passing signature validation as a collection of Prescription-Order bundles and/or error messages for Prescriptions failing signature validation as a collection of OperationOutcome resources (with the prescription-order messages attached as supportingInfo
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
apim-medicines-facadeAPIMMedicinesFacade

Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source

{
  "resourceType": "OperationDefinition",
  "id": "prescription-release",
  "meta": {
    "lastUpdated": "2022-10-17T11:39:00+00:00"
  },
  "url": "https://fhir.nhs.uk/OperationDefinition/prescription-release",
  "version": "4.0.1",
  "name": "PrescriptionRelease",
  "status": "draft",
  "kind": "operation",
  "date": "2022-10-17T11:39:00+00:00",
  "publisher": "NHS Digital",
  "contact": [
    {
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net"
        }
      ]
    }
  ],
  "description": "Use this operation to download prescriptions from Spine before it is dispensed. You can download a single prescription using the prescription's ID, or download up to 25 prescriptions (per request) nominated to a dispenser using the dispenser's ODS code. The operation will return prescriptions passing signature validation as a collection of Prescription-Order bundles and/or error messages for Prescriptions failing signature validation as a collection of OperationOutcome resources (with the prescription-order messages attached as supportingInfo",
  "affectsState": true,
  "code": "release",
  "comment": "Only one of the parameters group-identifier and owner MUST be provided. This operation performs both a query on the message queue and updates the status of returned prescriptions.",
  "resource": [
    "Task"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "outputProfile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Bundle-Collection",
  "parameter": [
    {
      "name": "group-identifier",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The short-form-prescription-id (token) of the prescription. Used for releasing Patient prescriptions",
      "type": "Identifier"
    },
    {
      "name": "owner",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The organization (pharmacy) downloading the prescriptions. Used for releasing Nominated Pharmacy prescriptions",
      "type": "Organization"
    },
    {
      "name": "status",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Status from ValueSet http://hl7.org/fhir/valueset-task-status.html Use: accepted",
      "type": "code"
    },
    {
      "name": "agent",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The professional submitting the release request",
      "type": "PractitionerRole"
    },
    {
      "name": "passedPrescriptions",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A FHIR Bundle (type=collection) which contains prescription-order FHIR Messages which match the search parameters. An empty search will still return a FHIR Bundle but with no entries.",
      "type": "Bundle"
    },
    {
      "name": "failedPrescriptions",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "A FHIR Bundle (type=collection) which contains OperationOutcome resources for each Prescription failing signature verification which matches the search parameters.",
      "type": "Bundle"
    }
  ]
}