AvaEcosystem Docs
Log in Request access

Patient

Demographics and identifiers for a person receiving care.

The anchor resource for almost every integration. In an EHR launch, the token response's patient field carries the id of the launched chart, and patient/Patient.* scopes are confined to that patient; user/Patient.rs follows the signed-in clinician's access instead.

Advertises a validated CA Core+ profile.

Access

Mode Interactions Scopes
App launch read + search patient/Patient.r, patient/Patient.rs, user/Patient.rs
Backend services read + search system/Patient.rs

Search parameters

Search results are searchset Bundles; follow the Bundle's next link for cursor pagination.

Parameter Type Description
_id token Match a specific logical resource id.
_lastUpdated date Filter by last modification time; supports FHIR date prefixes such as ge and lt.
_count number Page size hint for the searchset Bundle.
_page_token string Opaque pagination cursor. Never construct one — follow the Bundle's next link.
identifier token Business identifier, such as an Ontario health number.
name string Matches across family and given names.
family string Family (last) name.
given string Given (first) name.
birthdate date Date of birth; supports FHIR date prefixes.
gender token Administrative gender code.
phone token Phone telecom value.
email token Email telecom value.
active token Whether the record is in active use (true/false).

Read the launched patient

GET /Patient/{id} 200 OK
Request 
curl "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Patient/synthetic-patient-1" \
  -H "Authorization: Bearer $SMART_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"
Response · launch context 
{
  "resourceType": "Patient",
  "id": "synthetic-patient-1",
  "meta": {
    "profile": ["http://fhir.infoway-inforoute.ca/io/CA-Core/StructureDefinition/patient-ca-core|1.1.0"]
  },
  "identifier": [
    {
      "system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-patient-hcn",
      "value": "1234567890"
    }
  ],
  "active": true,
  "name": [{ "family": "Example", "given": ["Avery"] }],
  "telecom": [{ "system": "phone", "value": "555-0100", "use": "home" }],
  "gender": "unknown",
  "birthDate": "1987-04-12"
}

Search patients by name

GET /Patient?family={name} 200 OK
Request 
curl "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Patient?family=Example&_count=10" \
  -H "Authorization: Bearer $SMART_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"
Response · launch context 
{
  "resourceType": "Bundle",
  "type": "searchset",
  "link": [
    { "relation": "self", "url": "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Patient?family=Example&_count=10" },
    { "relation": "next", "url": "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Patient?family=Example&_count=10&_page_token=eyJvZmZzZXQiOjEwfQ" }
  ],
  "entry": [
    {
      "fullUrl": "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Patient/synthetic-patient-1",
      "resource": {
        "resourceType": "Patient",
        "id": "synthetic-patient-1",
        "name": [{ "family": "Example", "given": ["Avery"] }],
        "gender": "unknown",
        "birthDate": "1987-04-12"
      },
      "search": { "mode": "match" }
    }
  ]
}