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.

prepare

Name Url
prepare-message https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message

Invocations

URL: [base]/$prepare

Parameters (In)

NameCardinalityTypeDocumentation
content1..1Bundle

The prescription order message to process (without Provence resource)

Return Values (Out)

NameCardinalityTypeDocumentation
message-digest1..1string

Message Digest response containing the signed signature in XML format

This operation does not use the parameters resource for input parameters, it does for the response. \n\n A server may return one of several status codes: \n\n * 200 OK: Indicates that the message has been fully processed.

{
    "resourceType": "OperationDefinition",
    "id": "MessageHeader-prepare-message",
    "url": "https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message",
    "version": "4.0.1",
    "name": "Prepare Message",
    "status": "draft",
    "kind": "operation",
    "date": "2020-08-03T00:00:00+00:00",
    "publisher": "NHS Digital",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net"
                }
            ]
        }
    ],
    "description": "Convert a prescription in FHIR format into the canonicalised HL7 V3 signature fragments which should be signed by the prescriber.",
    "code": "prepare",
    "comment": "This operation does not use the parameters resource for input parameters, it does for the response.  \\n\\n A server may return one of several status codes: \\n\\n * **200 OK**: Indicates that the message has been fully processed.",
    "system": true,
    "type": false,
    "instance": false,
    "parameter":  [
        {
            "name": "content",
            "use": "in",
            "min": 1,
            "max": "1",
            "documentation": "The prescription order message to process (without Provence resource)",
            "type": "Bundle"
        },
        {
            "name": "message-digest",
            "use": "out",
            "min": 1,
            "max": "1",
            "documentation": "Message Digest response containing the signed signature in XML format",
            "type": "string"
        }
    ]
}
<OperationDefinition xmlns="http://hl7.org/fhir">
    <id value="MessageHeader-prepare-message" />
    <url value="https://fhir.nhs.uk/OperationDefinition/MessageHeader-prepare-message" />
    <version value="4.0.1" />
    <name value="Prepare Message" />
    <status value="draft" />
    <kind value="operation" />
    <date value="2020-08-03T00:00:00+00:00" />
    <publisher value="NHS Digital" />
    <contact>
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
        </telecom>
    </contact>
    <description value="Convert a prescription in FHIR format into the canonicalised HL7 V3 signature fragments which should be signed by the prescriber." />
    <code value="prepare" />
    <comment value="This operation does not use the parameters resource for input parameters, it does for the response.  \n\n A server may return one of several status codes: \n\n * **200 OK**: Indicates that the message has been fully processed." />
    <system value="true" />
    <type value="false" />
    <instance value="false" />
    <parameter>
        <name value="content" />
        <use value="in" />
        <min value="1" />
        <max value="1" />
        <documentation value="The prescription order message to process (without Provence resource)" />
        <type value="Bundle" />
    </parameter>
    <parameter>
        <name value="message-digest" />
        <use value="out" />
        <min value="1" />
        <max value="1" />
        <documentation value="Message Digest response containing the signed signature in XML format" />
        <type value="string" />
    </parameter>
</OperationDefinition>
back to top