Create a Care Record Note (Transactional)

Overview

The Create a Care Record Note endpoint allows 3rd Party Transactional apps to add notes to the patient’s care record. The notes take the form of a “note” string and are accompanied by metadata, including a SNOMED CT code.

Note: when saving a Care Record Note, it’s "status" is set to FINALISED.

Making a Request

Method: POST

URL: https://{{medicusTenant}}.{{medicusBaseURL}}/transactional-api/v1/patient/{{patientId}}/create-care-record-note

Request Headers

Header	Value	Description
`Authorization`	`Bearer [token]`	The JWT token provided by the Consumer
`Idempotency-Key`	UUID	The unique idempotency key

URL Parameters

Parameter

Description

Validation Rules

patientId

The Medicus Patient ID

e.g. e9af860e-cf8e-4272-b81a-a95cc8a531f7

Mandatory

UUID

Body Parameters

Parameter	Nested-parameters	Description	Validation Rules
`recordDate`	N/A	The date that the note was recorded	date required
`code`	`conceptId` `description`		SNOMED CT code
`note`	N/A	The care record note note	string
`recordedByPractitioner`	`name` `identifier` `identifierType`	The document’s author	Practitioner Accepted identifier types: `gb-gmc-number` `gb-gphc-number` `gb-hcpc-number` `gb-nmc-pin`
`recordedByOrganisation`	`name` `identifier` `identifierType`	The organisation that the document was authored by	Organisation Accepted identifier types: `nhs-england-ods-code` `medicus-tenant-id`

Example Request

JSON

GET /transactional-api/v1/patient/ec7be6f2-360c-11ed-b451-060b232f1aa2/create-care-record-note
Authorization: Bearer [token]
Idempotency-Key: c6433ae4-a699-41dc-b24e-8b53882509a9

{
    "recordDate": "2022-04-20",
    "code": {
        "conceptId": "24731000000108",
        "description": "Clinic note"
    },
    "note": "Patient told to stay at home and monitor conditions. Stay hydrated, stay at home and call back if symptoms do not improve.",
    "recordedByPractitioner": {
        "name": "Dr Joel Ward",
        "identifier": "AC12345",
        "identifierType": "gb-gmc-number"
    },
    "recordedByOrganisation": {
        "name": "Felix White Clinic",
        "identifier": "F85003",
        "identifierType": "nhs-england-ods-code",
    }
}

Response Details

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		The upload was successful
`200`	`INVALID_DATE`	The date supplied is in the future or is in an invalid format
`400`	`MISSING_REQUIRED_PROPERTY`	The body payload is missing one or more required properties.
`400`	`INVALID_ENUM_VALUE`	The enum value provided for the field {{fieldName}} is invalid

Example Response (Missing Required Field)

JSON

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "errors": [
    {
      "code": "MISSING_REQUIRED_PROPERTY",
      "title": "Missing required Property",
      "detail": "Missing field required {$fieldName}"
    }
  ]
}

Example Response (Successful Recording of Note)

JSON

HTTP/1.1 200 OK

{
    "success": true
}