HAhalaxy
Patient

List Patients

Changed on

Retrieves a list or collection of patient records

get/main/Patient

Request

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

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_summary[]string[]
_idstring

The logical id of the resource

namestring

search by family, given or preferred name

familystring

A portion of the family name of the patient

givenstring

A portion of the given name of the patient

emailstring

A value in an email contact

phonestring

A value in a phone contact. Supports local and international (E.164) format. Includes contact phone numbers.

statusstring

The status of a patient

_lastUpdatedstring datetime

The last updated date of the patient

birthdatestring date

The birthdate of the patient

createdstring datetime

The date of creation of the patient

general-practitionerstring

The Practitioner or Clinic that has a relationship with the patient

_include'Patient:general-practitioner'

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.
_sort'_lastUpdated' | 'name' | 'created' | '-_lastUpdated' | '-name' | '-created'

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Response

Patient collection

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 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/fhir+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/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/fhir+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 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/fhir+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 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)