HAhalaxy
Patient

Update Patient

Changed on

Updates specific fields in an existing patient record

patch/main/Patient/{id}

Request

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

Path parameters

idstring required

Patient identifier

Request body

activeboolean nullable

Indicates whether this patient profile is active based on the patient status - patient status considered active: Current, Claimant, Contact

genderstring nullable

male | female | other | custom gender

birthDatestring date nullable

The date of birth for the individual

deceasedBooleanboolean nullable

Indicates whether this patient profile is deceased based on the patient status

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The patient ID in the practice group

resourceTypestring nullable

Resource Type

Example request

{
  "active": true
}

Response

Patient resource updated

activeboolean nullable

Indicates whether this patient profile is active based on the patient status - patient status considered active: Current, Claimant, Contact

genderstring nullable

male | female | other | custom gender

birthDatestring date nullable

The date of birth for the individual

deceasedBooleanboolean nullable

Indicates whether this patient profile is deceased based on the patient status

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The patient ID in the practice group

resourceTypestring nullable

Resource Type

Example response

{
  "active": true
}

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the request property //

    • warning

      removed the request property //

    • 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/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/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 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/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 image/gif enum value to the // response property for the response status (media type: application/fhir+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 ValueSet enum value to the request property //

    • info

      added the new ValueSet enum value to the request property ///////

    • info

      added the new ValueSet enum value to the request property /////

    • info

      added the new ValueSetConcept enum value to the request property //

    • info

      added the new ValueSetConcept enum value to the request property ///////

    • info

      added the new ValueSetConcept enum value to the request property /////

    • info

      added the new image/gif enum value to the request property //