HAhalaxy
DocumentReference

Update a Note record

Changed on

Partially update an existing Note record

patch/main/DocumentReference/{id}

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/DocumentReference/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Path parameters

idstring required

DocumentReference identifier

Request body

status'current' | 'superseded'

The status of the document reference

docStatus'preliminary' | 'final' required

The status of the clinical note - preliminary for Draft, final for Published

datestring date-time nullable

The date and time when the clinical note was created

descriptionstring nullable required

The title of the clinical note

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example request

{
  "status": "current",
  "docStatus": "preliminary",
  "description": "My New Clinical Note"
}

Response

DocumentReference resource updated

status'current' | 'superseded'

The status of the document reference

docStatus'preliminary' | 'final' required

The status of the clinical note - preliminary for Draft, final for Published

datestring date-time nullable

The date and time when the clinical note was created

descriptionstring nullable required

The title of the clinical note

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

{
  "status": "current",
  "docStatus": "preliminary",
  "description": "My New Clinical Note"
}

Changes