API Reference

Create DocumentReference

post
https://au-api.halaxy.com/main/DocumentReference

Creates a single clinical note in a patient profile

Body Params

The new DocumentReference resource

masterIdentifier

The master identifier for the document

string
enum
Defaults to current

The status of the document reference

Allowed:
string
enum
required

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

Allowed:
type
object

Kind of document (LOINC if possible)

category
array of objects

Categorization of document

category
subject
object
required
author
array of objects
required
length ≥ 1

The practitioner and practice location linked as the clinical note owner

author*
string
required

The URL (relative or absolute) to the resource being referenced

string | null
enum

The type of resource being referenced

custodian
object

Who/what is the custodian of the clinical note

string | null
required

The title of the clinical note

content
array of objects
length ≥ 1

The content of the clinical note

content
attachment
object
format

Format/content rules for the attachment

meta

Metadata about the resource

string | null

Resource Type

Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

Updated 8 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json

Updated 8 months ago