Skip to main content
Skip table of contents

Override Consent

The ‘Do Not Share’ feature is only available within the New Zealand region

Overview

When requested by the associated patient, pregnancy records within the BadgerNet Spine can be flagged with an optional attribute that adds an additional layer of privacy control. The flag, known as ‘Do Not Share', is assigned to the pregnancy along with a free-text reason which indicates the reason for the attribute being applied to the record. Subsequent requests by a Spine Client to read the pregnancy are rejected unless the client has explicitly requested to bypass the patient’s privacy wishes, for example, while administering clinical care during the pregnancy. Only requests to read the pregnancy are restricted by the Do Not Share attribute; requests to update the record are not affected.

Once a Spine Client has overridden consent for a given pregnancy, the override remains in place for all future requests made by that client, in other words, it is not necessary to override consent each time the pregnancy is read.

Request

POST [baseUrl]/Patient/{logical-id}/$override-consent

Parameters

Name

Type

Description

logical-id

String (path)

The logical ID of the Pregnancy for which to override consent

Category

String (header)

The Category header must be included in the request, and contain the reason field to indicate why the Do Not Share wishes of the patient are being bypassed. See Request Headers | Purpose-of-Use for further details.

Body

JSON
{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "category",
            "valueCodeableConcept": {
                "coding": [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
                        "code": "ICOL"
                    }
                ]
            }
        }
    ]
}

Response

Possible Response Codes

Code

Description

204

Updated

The client’s override has been successfully added to the record

400

Bad Request

The format of the request was invalid, for example, the reason field was not included in the Purpose of Use header. See the OperationOutcome resource in the response for further details.

404

Not Found

The pregnancy was not found

409

Conflict

An existing override is already in place for the client on this pregnancy

422

Unprocessable Entity

The override could not be applied for logical reasons. See the OperationOutcome resource in the response for further details.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.