Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
DocumentReference

Create DocumentReference

Creates a single clinical note in a patient profile

post/main/DocumentReference

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

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 created

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

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

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