Patient (Residents)

An outward, read-only view of a resident's demographics and identifiers, mapped to FHIR Patient. Identifier values are returned masked exactly as the system of record returns them — the API never unmasks them.

FHIR PatientRequires residents.read

Read-only

This resource is read-only. Clinical and financial writes are confirmed by a human inside the product and are not exposed on the integration API.

Endpoints

GET/api/v1/ofctx/{org_id}/{facility_id}/residents

List residents (FHIR Patient search)

Requires scope residents.read

Base URL

https://medflo-pcc-vendor-api-eez5kqwsxa-uw.a.run.app

Parameter	In	Type	Description
`org_id`required	path	string (uuid)	Your organization id. Must match the org bound to your credentials — mismatches are rejected (403).
`facility_id`required	path	string (uuid)	A facility within your org that your credentials are granted. Out-of-scope facilities are rejected (403).
`q`	query	string	Free-text search across name/identifiers.
`page`	query	integer	1-based page number. Default `1`.
`page_size`	query	integer	Rows per page (1–200). Default `50`.

Example response 200 OK

json

{
  "data": [
    {
      "resourceType": "Patient",
      "id": "8f2c1e4a-...",
      "identifier": [
        {
          "system": "urn:medflo:resident-id",
          "value": "8f2c1e4a-..."
        },
        {
          "system": "urn:medflo:mrn",
          "value": "MRN••••4821"
        }
      ],
      "name": [
        {
          "family": "Doe",
          "given": [
            "Jane"
          ]
        }
      ],
      "gender": "female",
      "birthDate": "1946-03-11",
      "active": true
    }
  ],
  "meta": {
    "page": {
      "page": 1,
      "page_size": 50,
      "total": 128
    }
  },
  "error": null
}

GET/api/v1/ofctx/{org_id}/{facility_id}/residents/{resident_id}

Read a resident (FHIR Patient/{id})

Requires scope residents.read

Base URL

https://medflo-pcc-vendor-api-eez5kqwsxa-uw.a.run.app

Parameter	In	Type	Description
`org_id`required	path	string (uuid)	Your organization id. Must match the org bound to your credentials — mismatches are rejected (403).
`facility_id`required	path	string (uuid)	A facility within your org that your credentials are granted. Out-of-scope facilities are rejected (403).
`resident_id`required	path	string (uuid)	The resident id.

Example response 200 OK

json

{
  "data": {
    "resourceType": "Patient",
    "id": "8f2c1e4a-...",
    "identifier": [
      {
        "system": "urn:medflo:resident-id",
        "value": "8f2c1e4a-..."
      }
    ],
    "name": [
      {
        "family": "Doe",
        "given": [
          "Jane"
        ]
      }
    ],
    "gender": "female",
    "birthDate": "1946-03-11",
    "active": true
  },
  "meta": null,
  "error": null
}

Notes

All responses use the { data, meta, error } envelope. List responses carry pagination in meta.page.
Identifiers and codes are returned exactly as the system of record provides them — identifier values stay masked; the API never unmasks.
See Errors for the failure envelope and Rate limits for throttling headers.