HAhalaxy
DocumentReference

Create DocumentReference

Changed on

Creates a single clinical note in a patient profile

post/main/DocumentReference

Request

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

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

containedFhirResourceInterfaceJsonfhir[]

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 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

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

  • 1a14a579daecRevision changes
    • breaking

      added the new required request property // (media type: application/fhir+json)

    • breaking

      added the new required request property / (media type: application/fhir+json)

    • breaking

      the / request property type changed from no type to object (media type: application/fhir+json)

    • breaking

      the // request property type changed from no type to object (media type: application/fhir+json)

    • breaking

      the request property type changed from no type to object (media type: application/fhir+json)

    • breaking

      the / response's property type changed from no type to object for status (media type: application/fhir+json)

    • breaking

      the // response's property type changed from no type to object for status (media type: application/fhir+json)

    • breaking

      the response's property type changed from no type to object for status (media type: application/fhir+json)

    • warning

      removed from the // request property allOf list (media type: application/fhir+json)

    • warning

      removed from the / request property allOf list (media type: application/fhir+json)

    • warning

      removed from the request property allOf list (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the / response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the / response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the / response property for the response status (media type: application/json)

    • warning

      added the new image/gif enum value to the /// response property for the response status (media type: application/json)

    • info

      added the new optional request property // (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property /// (media type: application/fhir+json)

    • info

      added the new optional request property (media type: application/fhir+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property / (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property // (media type: application/json)

    • info

      added the new ValueSet enum value to the request property / (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property / (media type: application/json)

    • info

      added the new ValueSet enum value to the request property ////////// (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property ////////// (media type: application/json)

    • info

      added the new ValueSet enum value to the request property / (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property // (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property / (media type: application/fhir+json)

    • info

      added the new ValueSetConcept enum value to the request property / (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property ////////// (media type: application/fhir+json)

    • info

      added the new ValueSetConcept enum value to the request property ////////// (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property / (media type: application/json)

    • info

      added the new image/gif enum value to the request property /// (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/fhir+json)

    • info

      added the optional property // to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property /// to the response with the status (media type: application/fhir+json)

    • info

      added the optional property to the response with the status (media type: application/fhir+json)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: application/fhir+json)

    • info

      added the optional property / to the response with the status (media type: application/fhir+json)

    • info

      removed from the // response property allOf list for the response status (media type: application/fhir+json)

    • info

      removed from the / response property allOf list for the response status (media type: application/fhir+json)

    • info

      removed from the response property allOf list for the response status (media type: application/fhir+json)

    • info

      added the required property // to the response with the status (media type: application/fhir+json)

    • info

      added the required property / to the response with the status (media type: application/fhir+json)