Maximus FHIR API
ONC §170.315(g)(10)

API reference

Every function, parameter and return structure exposed by the Maximus FHIR R4 (4.0.1) API, generated from the server's own CapabilityStatement.

Service base URL

All FHIR interactions are relative to a single service base URL. Maximus is a multi-tenant platform, and each practice is reachable at the same base:

GEThttps://fhir.maximus.care/api/r4

The full list of service base URLs is published, without authentication, as required by 45 CFR 170.404(a)(3):

GEThttps://fhir.maximus.care/api/r4/service_based_url

API syntax

The API is a RESTful HL7 FHIR R4 (4.0.1) server. Requests follow the FHIR HTTP specification: a resource is addressed by type and logical id, and a search is a query against a resource type.

FunctionSyntaxReturns
readGET [base]/[Type]/[id]The requested resource
search-typeGET [base]/[Type]?[parameters]Bundle (searchset)
search-typePOST [base]/[Type]/_searchBundle (searchset)
capabilitiesGET [base]/metadataCapabilityStatement

Required request headers

HeaderValueRequired
AuthorizationBearer <access_token>Required on every call except /metadata, /service_based_url and the SMART discovery documents
Acceptapplication/fhir+jsonOptional — JSON is the default and the only supported representation
Content-Typeapplication/x-www-form-urlencodedPOST _search only
JSON only

The server declares application/fhir+json as its only supported format. XML is not supported. Requesting XML returns 406 Not Acceptable.

Search parameter syntax

Parameters are combined with & and are AND-ed together. Repeating a parameter OR-s its values. Token parameters may be qualified by code system using a pipe.

# all of a patient's conditions
GET https://fhir.maximus.care/api/r4/Condition?patient=example-patient

# narrowed to one category, system-qualified
GET https://fhir.maximus.care/api/r4/Condition?patient=example-patient&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

# a date range, using comparator prefixes
GET https://fhir.maximus.care/api/r4/Observation?patient=example-patient&date=ge2026-01-01&date=le2026-12-31

# the same search issued as a POST
POST https://fhir.maximus.care/api/r4/Observation/_search
Content-Type: application/x-www-form-urlencoded

patient=example-patient&category=vital-signs

Return structures

Three response shapes cover every interaction.

InteractionHTTP statusBody
read — found200 OKThe resource, as a single FHIR JSON object with resourceType set to the requested type
search-type200 OKA Bundle with type: "searchset", a total, link entries for paging, and an entry array of matching resources
Any failure4xx / 5xxAn OperationOutcome — see errors and exceptions

Search result structure

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 2,
  "link": [
    { "relation": "self", "url": "https://fhir.maximus.care/api/r4/Condition?patient=example-patient" },
    { "relation": "next", "url": "https://fhir.maximus.care/api/r4/Condition?patient=example-patient&_page=2" }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.maximus.care/api/r4/Condition/example-condition",
      "resource": { "resourceType": "Condition", "id": "example-condition" },
      "search": { "mode": "match" }
    }
  ]
}
Paging

Follow the next link in Bundle.link until it is absent. Do not construct paging URLs yourself — treat the link as opaque.

Bulk data export

Population-level export follows FHIR Bulk Data Access 2.0.0 and is asynchronous.

StepRequestResponse
1. Kick offGET [base]/Group/{groupId}/$export
with Prefer: respond-async
202 Accepted plus a Content-Location polling URL
2. PollGET [base]/$export-poll-status?...202 while in progress; 200 with a manifest when complete
3. DownloadGET each manifest output.urlapplication/fhir+ndjson, one resource per line

Bulk export requires a system/ scope obtained through the SMART Backend Services flow.

Kick-off parameters

Anything not listed below is rejected with 400 and an OperationOutcome rather than ignored, so a filter you send is either applied or refused — never silently dropped.

ParameterSupportedBehaviour
_outputFormatYesapplication/fhir+ndjson, application/ndjson and ndjson are accepted and equivalent. Any other value is refused.
_typeYesA comma-separated list of resource types. The export is filtered to those types. A type this server does not export is refused, and the error lists the types that are available.
_sinceAccepted — see belowAccepted and validated, but it does not reduce the result set. A malformed instant is refused.
_typeFilterNoRefused with 400.
_elementsNoRefused with 400.
What _since does here

This server does not maintain a last-updated time for the resources it exports, so an export with _since returns the same resources as one without it. The parameter is accepted rather than refused, and the kick-off URL you sent is echoed back in the manifest's request field so you can confirm exactly what was requested.

This is explicitly permitted by the specification, which states that “for resources where the server does not maintain a last updated time, the server MAY include these resources in a response irrespective of the _since value supplied by a client” (Bulk Data Access 2.0.0, kick-off parameters).

What this means for you. You will receive a superset of what you asked for, never less, so an incremental sync will not miss data — but it cannot be used to reduce transfer size, and you should de-duplicate against what you already hold rather than assuming everything returned is new. Use _type to limit an export.

The manifest's deleted array is omitted for the same reason: deletions are tracked relative to a _since window this server does not maintain.

Resource reference

29 resource types are supported, 21 of which support search. Expand a type for its interactions, parameters, data types and profiles. This section is generated directly from the server's CapabilityStatement, which you can always fetch live:

GEThttps://fhir.maximus.care/api/r4/metadata
AllergyIntolerancereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/AllergyIntolerance/{id}A single AllergyIntolerance resource
search-typeGET/AllergyIntolerance?{parameters}A Bundle of type searchset
search-typePOST/AllergyIntolerance/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a AllergyIntolerance search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/AllergyIntolerance?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "AllergyIntolerance",
  "id": "example-allergyintolerance",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
    ]
  },
  "identifier": [
    {
      "use": "official",
      "system": "https://hl7.org/fhir/identifier-use",
      "value": "example-identifier"
    }
  ],
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "active",
        "display": "Active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "criticality": "low",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "91935009",
        "display": "Allergy to peanuts (disorder)"
      }
    ],
    "text": "Allergy to peanuts (disorder)"
  },
  "patient": {
    "reference": "Patient/example-patient"
  },
  "onsetDateTime": "1960-01-13T00:00:00-06:00",
  "reaction": [
    {
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "418290006",
              "display": "Itching"
            }
          ],
          "text": "Itching"
        }
      ]
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

CarePlanreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/CarePlan/{id}A single CarePlan resource
search-typeGET/CarePlan?{parameters}A Bundle of type searchset
search-typePOST/CarePlan/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a CarePlan search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-careplan — http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan

Example request

curl -X GET "https://fhir.maximus.care/api/r4/CarePlan?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "CarePlan",
  "id": "example-careplan",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:08.3478588-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><strong>Care plan</strong><br/>Assessments:<ul><li>Care Plan for Respiratory therapy</li></ul>.<br/>Activities:<ul><li>Recommendation to avoid exercise</li><li>Deep breathing and coughing exercises</li></ul></div>"
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    },
    {
      "text": "Care Plan for Respiratory therapy"
    }
  ],
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "period": {
    "start": "1960-05-11T12:00:00-04:00",
    "end": "1960-05-11T12:00:00-04:00"
  },
  "careTeam": [
    {
      "reference": "CareTeam/example-careteam"
    }
  ],
  "activity": [
    {
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "304510005",
              "display": "Recommendation to avoid exercise"
            }
          ],
          "text": "Recommendation to avoid exercise"
        },
        "status": "unknown",
        "location": {
          "reference": "Location/example-location",
          "display": "Example Location"
        }
      }
    },
    {
      "detail": {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "371605008",
              "display": "Deep breathing and coughing exercises"
            }
          ],
          "text": "Deep breathing and coughing exercises"
        },
        "status": "unknown",
        "location": {
          "reference": "Location/example-location",
          "display": "Example Location"
        }
      }
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

CareTeamreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/CareTeam/{id}A single CareTeam resource
search-typeGET/CareTeam?{parameters}A Bundle of type searchset
search-typePOST/CareTeam/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
statustokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

US Core requires patient on a CareTeam search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-careteam — http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam

Example request

curl -X GET "https://fhir.maximus.care/api/r4/CareTeam?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "CareTeam",
  "id": "example-careteam",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:08.6487998-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
    ]
  },
  "status": "active",
  "subject": {
    "reference": "Patient/example-patient",
    "display": "Example Patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "participant": [
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "453231000124104",
              "display": "Primary care provider"
            }
          ],
          "text": "Primary care provider"
        }
      ],
      "member": {
        "reference": "Practitioner/example-practitioner",
        "display": "Example Practitioner"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "116154003",
              "display": "Patient"
            }
          ],
          "text": "Patient"
        }
      ],
      "member": {
        "reference": "Patient/example-patient",
        "display": "Example Patient"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "133932002",
              "display": "Caregiver (person)"
            }
          ],
          "text": "Caregiver (person)"
        }
      ],
      "member": {
        "reference": "RelatedPerson/example-relatedperson",
        "display": "Example RelatedPerson"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "116154003",
              "display": "Healthcare services (qualifier value)"
            }
          ],
          "text": "Healthcare services (qualifier value)"
        }
      ],
      "member": {
        "reference": "Organization/example-organization",
        "display": "Example Organization"
      }
    }
  ],
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "88805009",
          "display": "Chronic congestive heart failure (disorder)"
        }
      ]
    }
  ],
  "managingOrganization": [
    {
      "reference": "Organization/example-organization",
      "display": "Example Organization"
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Conditionreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Condition/{id}A single Condition resource
search-typeGET/Condition?{parameters}A Bundle of type searchset
search-typePOST/Condition/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a Condition search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Condition?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Condition",
  "id": "example-condition",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:05.6758616-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"
    ]
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-asserted-date",
      "valueDateTime": "2023-08-01T08:07:00-05:00"
    }
  ],
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
        "code": "active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
        "code": "confirmed"
      }
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-category",
          "code": "problem-list-item",
          "display": "Problem List Item"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "88805009",
        "display": "Chronic congestive heart failure (disorder)"
      }
    ],
    "text": "Chronic congestive heart failure (disorder)"
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "onsetDateTime": "1960-05-11T09:00:00-05:00",
  "recordedDate": "1960-05-11T09:00:00-05:00"
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Coveragereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Coverage/{id}A single Coverage resource
search-typeGET/Coverage?{parameters}A Bundle of type searchset
search-typePOST/Coverage/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a Coverage search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-coverage — http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Coverage?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Devicereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Device/{id}A single Device resource
search-typeGET/Device?{parameters}A Bundle of type searchset
search-typePOST/Device/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a Device search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Device?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
DiagnosticReportreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/DiagnosticReport/{id}A single DiagnosticReport resource
search-typeGET/DiagnosticReport?{parameters}A Bundle of type searchset
search-typePOST/DiagnosticReport/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
categorytokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
codetokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
datedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.

US Core requires patient on a DiagnosticReport search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/DiagnosticReport?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "DiagnosticReport",
  "id": "example-diagnosticreport",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:07.7943731-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
    ]
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "LP29684-5",
          "display": "Radiology"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "18748-4",
        "display": "diagnostic imaging study"
      }
    ]
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "effectiveDateTime": "1960-05-11T09:00:00-05:00",
  "issued": "1960-05-11T09:00:00-05:00",
  "performer": [
    {
      "reference": "Practitioner/example-practitioner",
      "display": "Example Practitioner"
    },
    {
      "reference": "Practitioner/example-practitioner"
    },
    {
      "reference": "Organization/example-organization"
    }
  ],
  "presentedForm": [
    {
      "contentType": "text/plain",
      "data": "RE9COiAwMy8yOS8xOTQwDQojIENoaWVmIENvbXBsYWludA0KTm8gY29tcGxhaW50cy4NCiMgSGlzdG9yeSBvZiBQcmVzZW50IElsbG5lc3MNCk5vIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzLg0KIyBTb2NpYWwgSGlzdG9yeQ0KUGF0aWVudCBpcyBNYXJyaWVkLiBQYXRpZW50IGhhcyBzbW9raW5nIFN0YXR1cyBOZXZlciBzbW9rZXIuIFBhdGllbnQgaGFzIEFsY29ob2xVc2UgU3RhdHVzIC4gUGF0aWVudCBoYXMgRHJ1Z1VzZSBTdGF0dXMgLiANCiMgQWxsZXJnaWVzDQpBbGxlcmd5IHRvIHBlYW51dHMgKGRpc29yZGVyKSwgd2hlYXQgYnJhbiBhbGxlcmdlbmljIGV4dHJhY3QsIA0KIyBNZWRpY2F0aW9ucw0KYWxidXRlcm9sIDkwIE1DRy9JTkhBTCBNZXRlcmVkIERvc2UgSW5oYWxlciwgMjAwIEFjdHVhdGlvbnMsIGdlbmVyaWMgZm9yIFByb3ZlbnRpbCwgYW1veGljaWxsaW4gMjUwIE1HIC8gY2xhdnVsYW5hdGUgMTI1IE1HIE9yYWwgVGFibGV0LCBhbGJ1dGVyb2wgOTAgTUNHL0lOSEFMIE1ldGVyZWQgRG9zZSBJbmhhbGVyLCAyMDAgQWN0dWF0aW9ucywgZ2VuZXJpYyBmb3IgUHJvdmVudGlsLCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIGFsYnV0ZXJvbCA5MCBNQ0cvSU5IQUwgTWV0ZXJlZCBEb3NlIEluaGFsZXIsIDIwMCBBY3R1YXRpb25zLCBnZW5lcmljIGZvciBQcm92ZW50aWwsIGFtb3hpY2lsbGluIDI1MCBNRyAvIGNsYXZ1bGFuYXRlIDEyNSBNRyBPcmFsIFRhYmxldCwgYWxidXRlcm9sIDkwIE1DRy9JTkhBTCBNZXRlcmVkIERvc2UgSW5oYWxlciwgMjAwIEFjdHVhdGlvbnMsIGdlbmVyaWMgZm9yIFByb3ZlbnRpbCwgYW1veGljaWxsaW4gMjUwIE1HIC8gY2xhdnVsYW5hdGUgMTI1IE1HIE9yYWwgVGFibGV0LCBhbGJ1dGVyb2wgOTAgTUNHL0lOSEFMIE1ldGVyZWQgRG9zZSBJbmhhbGVyLCAyMDAgQWN0dWF0aW9ucywgZ2VuZXJpYyBmb3IgUHJvdmVudGlsLCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIGFsYnV0ZXJvbCA5MCBNQ0cvSU5IQUwgTWV0ZXJlZCBEb3NlIEluaGFsZXIsIDIwMCBBY3R1YXRpb25zLCBnZW5lcmljIGZvciBQcm92ZW50aWwsIGFtb3hpY2lsbGluIDI1MCBNRyAvIGNsYXZ1bGFuYXRlIDEyNSBNRyBPcmFsIFRhYmxldCwgYWxidXRlcm9sIDkwIE1DRy9JTkhBTCBNZXRlcmVkIERvc2UgSW5oYWxlciwgMjAwIEFjdHVhdGlvbnMsIGdlbmVyaWMgZm9yIFByb3ZlbnRpbCwgYW1veGljaWxsaW4gMjUwIE1HIC8gY2xhdnVsYW5hdGUgMTI1IE1HIE9yYWwgVGFibGV0LCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIA0KIyBBc3Nlc3NtZW50IGFuZCBQbGFuDQooMSkgU3RhdHVzIDphY3RpdmUNCkFzc2Vzc21lbnRzOg0KQ2FyZSBQbGFuIGZvciBSZXNwaXJhdG9yeSB0aGVyYXB5DQoNClBsYW46DQpSZWNvbW1lbmRhdGlvbiB0byBhdm9pZCBleGVyY2lzZQ0KRGVlcCBicmVhdGhpbmcgYW5kIGNvdWdoaW5nIGV4ZXJjaXNlcw0KDQoNCg=="
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

DocumentReferencereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/DocumentReference/{id}A single DocumentReference resource
search-typeGET/DocumentReference?{parameters}A Bundle of type searchset
search-typePOST/DocumentReference/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
categorytokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
typetokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
datedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.

US Core requires patient on a DocumentReference search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/DocumentReference?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "DocumentReference",
  "id": "example-documentreference",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:07.4266412-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
    ]
  },
  "identifier": [
    {
      "use": "official",
      "system": "https://hl7.org/fhir/Identifier-use",
      "value": "example-identifier"
    }
  ],
  "status": "current",
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "11506-3",
        "display": "progress note"
      }
    ],
    "text": "progress note"
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
          "code": "clinical-note",
          "display": "Clinical Note"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/example-patient"
  },
  "date": "1940-09-06T09:00:00-05:00",
  "author": [
    {
      "reference": "Practitioner/example-practitioner",
      "display": "Example Practitioner"
    }
  ],
  "custodian": {
    "reference": "Organization/example-organization",
    "display": "Example Organization"
  },
  "content": [
    {
      "attachment": {
        "contentType": "text/plain",
        "data": "RE9COiAwMy8yOS8xOTQwDQojIENoaWVmIENvbXBsYWludA0KTm8gY29tcGxhaW50cy4NCiMgSGlzdG9yeSBvZiBQcmVzZW50IElsbG5lc3MNCixQYXRpZW50IGlzIGEgNSBtb250aC1vbGQgTm9uIEhpc3BhbmljIHdoaXRlIG1hbGUuDQojIFNvY2lhbCBIaXN0b3J5DQpQYXRpZW50IGlzIE1hcnJpZWQuIFBhdGllbnQgaGFzIHNtb2tpbmcgU3RhdHVzIE5ldmVyIHNtb2tlci4gUGF0aWVudCBoYXMgQWxjb2hvbFVzZSBTdGF0dXMgLiBQYXRpZW50IGhhcyBEcnVnVXNlIFN0YXR1cyAuIA0KIyBBbGxlcmdpZXMNCkFsbGVyZ3kgdG8gcGVhbnV0cyAoZGlzb3JkZXIpLCB3aGVhdCBicmFuIGFsbGVyZ2VuaWMgZXh0cmFjdCwgDQojIE1lZGljYXRpb25zDQphbGJ1dGVyb2wgOTAgTUNHL0lOSEFMIE1ldGVyZWQgRG9zZSBJbmhhbGVyLCAyMDAgQWN0dWF0aW9ucywgZ2VuZXJpYyBmb3IgUHJvdmVudGlsLCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIGFsYnV0ZXJvbCA5MCBNQ0cvSU5IQUwgTWV0ZXJlZCBEb3NlIEluaGFsZXIsIDIwMCBBY3R1YXRpb25zLCBnZW5lcmljIGZvciBQcm92ZW50aWwsIGFtb3hpY2lsbGluIDI1MCBNRyAvIGNsYXZ1bGFuYXRlIDEyNSBNRyBPcmFsIFRhYmxldCwgYWxidXRlcm9sIDkwIE1DRy9JTkhBTCBNZXRlcmVkIERvc2UgSW5oYWxlciwgMjAwIEFjdHVhdGlvbnMsIGdlbmVyaWMgZm9yIFByb3ZlbnRpbCwgYW1veGljaWxsaW4gMjUwIE1HIC8gY2xhdnVsYW5hdGUgMTI1IE1HIE9yYWwgVGFibGV0LCBhbGJ1dGVyb2wgOTAgTUNHL0lOSEFMIE1ldGVyZWQgRG9zZSBJbmhhbGVyLCAyMDAgQWN0dWF0aW9ucywgZ2VuZXJpYyBmb3IgUHJvdmVudGlsLCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIGFsYnV0ZXJvbCA5MCBNQ0cvSU5IQUwgTWV0ZXJlZCBEb3NlIEluaGFsZXIsIDIwMCBBY3R1YXRpb25zLCBnZW5lcmljIGZvciBQcm92ZW50aWwsIGFtb3hpY2lsbGluIDI1MCBNRyAvIGNsYXZ1bGFuYXRlIDEyNSBNRyBPcmFsIFRhYmxldCwgYWxidXRlcm9sIDkwIE1DRy9JTkhBTCBNZXRlcmVkIERvc2UgSW5oYWxlciwgMjAwIEFjdHVhdGlvbnMsIGdlbmVyaWMgZm9yIFByb3ZlbnRpbCwgYW1veGljaWxsaW4gMjUwIE1HIC8gY2xhdnVsYW5hdGUgMTI1IE1HIE9yYWwgVGFibGV0LCBhbGJ1dGVyb2wgOTAgTUNHL0lOSEFMIE1ldGVyZWQgRG9zZSBJbmhhbGVyLCAyMDAgQWN0dWF0aW9ucywgZ2VuZXJpYyBmb3IgUHJvdmVudGlsLCBhbW94aWNpbGxpbiAyNTAgTUcgLyBjbGF2dWxhbmF0ZSAxMjUgTUcgT3JhbCBUYWJsZXQsIGFtb3hpY2lsbGluIDI1MCBNRyAvIGNsYXZ1bGFuYXRlIDEyNSBNRyBPcmFsIFRhYmxldCwgDQojIEFzc2Vzc21lbnQgYW5kIFBsYW4NCk5vIEFzc2Vzc21lbnQgUGxhbg0K",
        "title": "Encounter : 1940-09-06T09:00:00-05:00"
      },
      "format": {
        "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
        "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
        "display": "mimeType Sufficient"
      }
    }
  ],
  "context": {
    "encounter": [
      {
        "reference": "Encounter/example-encounter"
      }
    ],
    "period": {
      "start": "1940-09-06T09:00:00-05:00",
      "end": "1940-09-06T09:00:00-05:00"
    }
  }
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Encounterreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Encounter/{id}A single Encounter resource
search-typeGET/Encounter?{parameters}A Bundle of type searchset
search-typePOST/Encounter/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
datedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

US Core requires patient on a Encounter search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-encounter — http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Encounter?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Encounter",
  "id": "example-encounter",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:09.3999081-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
    ]
  },
  "identifier": [
    {
      "use": "official",
      "system": "https://hl7.org/fhir/Identifier-use",
      "value": "example-identifier"
    }
  ],
  "status": "unknown",
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "AMB"
  },
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "308335008",
          "display": "Patient encounter procedure (procedure)"
        }
      ],
      "text": "Patient encounter procedure (procedure)"
    }
  ],
  "subject": {
    "reference": "Patient/example-patient",
    "display": "Example Patient"
  },
  "participant": [
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PPRF",
              "display": "primary performer"
            }
          ],
          "text": "primary performer"
        }
      ],
      "period": {
        "start": "1940-09-06T09:00:00-05:00",
        "end": "1940-09-06T09:00:00-05:00"
      },
      "individual": {
        "reference": "Practitioner/example-practitioner",
        "display": "Example Practitioner"
      }
    }
  ],
  "period": {
    "start": "1940-09-06T09:00:00-05:00",
    "end": "1940-09-06T09:00:00-05:00"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "65363002",
          "display": "Otitis media (disorder)"
        }
      ],
      "text": "Otitis media (disorder)"
    }
  ],
  "location": [
    {
      "location": {
        "reference": "Location/example-location",
        "display": "Example Location"
      }
    }
  ],
  "serviceProvider": {
    "reference": "Organization/example-organization",
    "display": "Example Organization"
  }
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Goalreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Goal/{id}A single Goal resource
search-typeGET/Goal?{parameters}A Bundle of type searchset
search-typePOST/Goal/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a Goal search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-goal — http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Goal?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Goal",
  "id": "example-goal",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:08.9434254-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
    ]
  },
  "lifecycleStatus": "proposed",
  "description": {
    "text": "Dementia associated with alcoholism (disorder)"
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "startDate": "1958-05-23",
  "target": [
    {
      "dueDate": "1958-05-23"
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Immunizationreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Immunization/{id}A single Immunization resource
search-typeGET/Immunization?{parameters}A Bundle of type searchset
search-typePOST/Immunization/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a Immunization search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Immunization?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Immunization",
  "id": "example-immunization",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:06.9312565-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
    ]
  },
  "status": "completed",
  "statusReason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "IMMUNE",
        "display": "immunity"
      }
    ]
  },
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "140",
        "display": "AFLURIA, P-free"
      },
      {
        "system": "http://hl7.org/fhir/sid/ndc",
        "code": "33332-0013-01",
        "display": "AFLURIA, P-free"
      }
    ],
    "text": "AFLURIA, P-free"
  },
  "patient": {
    "reference": "Patient/example-patient"
  },
  "occurrenceDateTime": "1958-05-23",
  "primarySource": true,
  "location": {
    "reference": "Location/example-location",
    "display": "Example Location"
  },
  "doseQuantity": {
    "value": 0.5,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  },
  "education": [
    {
      "documentType": "253088698300010311190815",
      "publicationDate": "2019-08-15",
      "presentationDate": "1958-05-23"
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

MedicationDispensereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/MedicationDispense/{id}A single MedicationDispense resource
search-typeGET/MedicationDispense?{parameters}A Bundle of type searchset
search-typePOST/MedicationDispense/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.

US Core requires patient on a MedicationDispense search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/MedicationDispense?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
MedicationRequestreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/MedicationRequest/{id}A single MedicationRequest resource
search-typeGET/MedicationRequest?{parameters}A Bundle of type searchset
search-typePOST/MedicationRequest/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
intenttokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
statustokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

US Core requires patient on a MedicationRequest search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/MedicationRequest?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "MedicationRequest",
  "id": "example-medicationrequest",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:06.6064628-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
          "code": "community"
        }
      ]
    }
  ],
  "reportedBoolean": false,
  "medicationReference": {
    "reference": "Medication/example-medication"
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "authoredOn": "1947-01-22T09:30:00-06:00",
  "requester": {
    "reference": "Practitioner/example-practitioner",
    "display": "Example Practitioner"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/icd-10-cm",
          "code": "J45.909"
        }
      ],
      "text": "J45.909"
    }
  ],
  "dosageInstruction": [
    {
      "text": "As Needed",
      "timing": {
        "code": {
          "text": "Every 4 hours as needed"
        }
      },
      "asNeededBoolean": false,
      "route": {
        "text": "INHALATION"
      },
      "doseAndRate": [
        {
          "doseQuantity": {
            "value": 2,
            "unit": "puff"
          }
        }
      ]
    }
  ],
  "dispenseRequest": {
    "numberOfRepeatsAllowed": 0,
    "quantity": {
      "value": 1
    },
    "expectedSupplyDuration": {
      "value": 30,
      "unit": "days",
      "system": "http://unitsofmeasure.org",
      "code": "d"
    }
  }
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Observationreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Observation/{id}A single Observation resource
search-typeGET/Observation?{parameters}A Bundle of type searchset
search-typePOST/Observation/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
categorytokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
codetokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
datedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.

US Core requires patient on a Observation search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Observation?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Observation",
  "id": "example-observation",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:06.011186-06:00",
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/bp",
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "vital-signs"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "85354-9",
        "display": "Blood pressure panel with all children optional"
      }
    ],
    "text": "Blood pressure panel with all children optional"
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "effectiveDateTime": "2024-07-25T09:02:00-05:00",
  "issued": "2024-07-25T09:02:00-05:00",
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8462-4",
            "display": "Diastolic Blood Pressure"
          }
        ],
        "text": "Diastolic Blood Pressure"
      },
      "valueQuantity": {
        "value": 85,
        "unit": "mm[Hg]",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      }
    },
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8480-6",
            "display": "Systolic Blood Pressure"
          }
        ],
        "text": "Systolic Blood Pressure"
      },
      "valueQuantity": {
        "value": 140,
        "unit": "mm[Hg]",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      }
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Patientreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Patient/{id}A single Patient resource
search-typeGET/Patient?{parameters}A Bundle of type searchset
search-typePOST/Patient/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
identifiertokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
namestringOptionalCase-insensitive text. Matches from the start of the field unless a modifier is supplied.
birthdatedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.
gendertokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

Supported profiles

  • us-core-patient — http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Patient?_id=" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Patient",
  "id": "example-patient",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated by <a href=\"https://github.com/synthetichealth/synthea\">Synthea</a>.Version identifier: v2.6.1-3-g50f4f58f\n .   Person seed: 4286870567281389426  Population seed: 3</div>"
  },
  "extension": [
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2076-8",
            "display": "Native Hawaiian or Other Pacific Islander"
          }
        },
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2106-3",
            "display": "White"
          }
        },
        {
          "url": "text",
          "valueString": "Native Hawaiian or Other Pacific Islander, White"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
    },
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2135-2",
            "display": "HISPANIC OR LATINO"
          }
        },
        {
          "url": "text",
          "valueString": "HISPANIC OR LATINO"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
      "valueCode": "M"
    },
    {
      "extension": [
        {
          "url": "tribalAffiliation",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                "code": "340"
              }
            ],
            "text": "Native Village of Akhiok"
          }
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248153007"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
      "valueAddress": {
        "city": "ANYTOWN",
        "state": "NY",
        "country": "US"
      }
    }
  ],
  "identifier": [
    {
      "system": "https://example.org/identifier",
      "value": "example-identifier"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "MR",
            "display": "Medical Record Number"
          }
        ],
        "text": "Medical Record Number"
      },
      "system": "https://example.org/identifier",
      "value": "example-identifier-2"
    }
  ],
  "name": [
    {
      "use": "official",
      "text": "Delano, Marcus",
      "family": "Delano",
      "given": [
        "Marcus",
        "Elliot"
      ],
      "prefix": [
        "Mr."
      ],
      "suffix": [
        "PharmD"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "555-0100",
      "use": "mobile"
    },
    {
      "system": "phone",
      "value": "555-0101",
      "use": "home"
    },
    {
      "system": "phone",
      "value": "555-0102",
      "use": "work"
    }
  ],
  "gender": "male",
  "birthDate": "1940-03-29",
  "address": [
    {
      "use": "home",
      "type": "postal",
      "text": "100 Example Street ANYTOWN NY 12345",
      "line": [
        "100 Example Street"
      ],
      "city": "ANYTOWN",
      "state": "NY",
      "postalCode": "12345",
      "country": "US"
    },
    {
      "use": "old",
      "type": "postal",
      "text": "200 Sample Avenue ANYTOWN NY 12345",
      "line": [
        "200 Sample Avenue"
      ],
      "city": "ANYTOWN",
      "state": "NY",
      "postalCode": "12345",
      "country": "USA"
    }
  ],
  "maritalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
        "code": "M",
        "display": "Married"
      }
    ],
    "text": "Married"
  },
  "communication": [
    {
      "language": {
        "coding": [
          {
            "system": "urn:ietf:bcp:47",
            "code": "en",
            "display": "English"
          }
        ]
      },
      "preferred": true
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Procedurereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Procedure/{id}A single Procedure resource
search-typeGET/Procedure?{parameters}A Bundle of type searchset
search-typePOST/Procedure/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
datedate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.

US Core requires patient on a Procedure search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

  • us-core-procedure — http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Procedure?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Procedure",
  "id": "example-procedure",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2026-11-16T02:16:08.0789641-06:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
    ]
  },
  "basedOn": [
    {
      "reference": "ServiceRequest/example-servicerequest"
    }
  ],
  "status": "unknown",
  "code": {
    "coding": [
      {
        "system": "http://www.ama-assn.org/go/cpt",
        "code": "85014",
        "display": "BLOOD COUNT; HEMATOCRIT (HCT)"
      }
    ],
    "text": "BLOOD COUNT; HEMATOCRIT (HCT)"
  },
  "subject": {
    "reference": "Patient/example-patient"
  },
  "encounter": {
    "reference": "Encounter/example-encounter"
  },
  "performedDateTime": "1960-05-11T00:00:00-05:00",
  "location": {
    "reference": "Location/example-location",
    "display": "Example Location"
  }
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required.

Questionnairereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/Questionnaire/{id}A single Questionnaire resource
search-typeGET/Questionnaire?{parameters}A Bundle of type searchset
search-typePOST/Questionnaire/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Questionnaire?_id=" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
QuestionnaireResponsereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/QuestionnaireResponse/{id}A single QuestionnaireResponse resource
search-typeGET/QuestionnaireResponse?{parameters}A Bundle of type searchset
search-typePOST/QuestionnaireResponse/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

US Core requires patient on a QuestionnaireResponse search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/QuestionnaireResponse?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
ServiceRequestreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/ServiceRequest/{id}A single ServiceRequest resource
search-typeGET/ServiceRequest?{parameters}A Bundle of type searchset
search-typePOST/ServiceRequest/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
categorytokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
codetokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
authoreddate / dateTimeOptionalAn ISO 8601 date or instant, optionally with a comparator prefix such as ge, le, gt or lt.
statustokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

US Core requires patient on a ServiceRequest search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/ServiceRequest?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Example response

{
  "resourceType": "Bundle",
  "id": "example-bundle",
  "meta": {
    "lastUpdated": "2026-11-16T02:12:27.8161189-06:00"
  },
  "type": "searchset",
  "total": 7,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.maximus.care/api/r4/ServiceRequest?patient=example-patient"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.maximus.care/api/r4/ServiceRequest/example-servicerequest",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "example-servicerequest",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2026-11-16T02:12:27.8215975-06:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"
          ]
        },
        "status": "completed",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "363679005",
                "display": "Imaging"
              }
            ],
            "text": "Imaging"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "71046",
              "display": "Chest PA and Lateral"
            }
          ],
          "text": "Chest PA and Lateral"
        },
        "subject": {
          "reference": "Patient/example-patient",
          "display": "Example Patient"
        },
        "encounter": {
          "reference": "Encounter/example-encounter"
        },
        "occurrencePeriod": {
          "start": "1960-05-11",
          "end": "1960-05-18"
        },
        "authoredOn": "1960-05-11",
        "requester": {
          "reference": "Practitioner/example-practitioner",
          "display": "Example Practitioner"
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/sid/icd-10-cm",
                "code": "R07.1",
                "display": "Chest pain on breathing"
              }
            ],
            "text": "Chest pain on breathing"
          }
        ],
        "reasonReference": [
          {
            "reference": "Condition/example-condition",
            "display": "Example Condition"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Illustrative. Field presence varies with what is recorded for a given patient; the profile above defines which elements are required. This bundle is trimmed to 1 of its 7 entries so the page stays readable. total reports the real number of matches; a live response returns every entry in the page, and a next link when there are more.

Specimenread

Interactions

FunctionMethodPathReturns
readGET/Specimen/{id}A single Specimen resource

Supported profiles

  • us-core-specimen — http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Specimen/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
RelatedPersonreadsearch-type

Interactions

FunctionMethodPathReturns
readGET/RelatedPerson/{id}A single RelatedPerson resource
search-typeGET/RelatedPerson?{parameters}A Bundle of type searchset
search-typePOST/RelatedPerson/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
patientreferenceRequiredA reference to another resource, given as a bare logical id or as Type/id.
namestringOptionalCase-insensitive text. Matches from the start of the field unless a modifier is supplied.

US Core requires patient on a RelatedPerson search. A token carrying a patient launch context is bound to that patient, so supplying a different patient value returns 403 Forbidden.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/RelatedPerson?patient=example-patient" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Locationread

Interactions

FunctionMethodPathReturns
readGET/Location/{id}A single Location resource

Supported profiles

  • us-core-location — http://hl7.org/fhir/us/core/StructureDefinition/us-core-location

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Location/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Medicationread

Interactions

FunctionMethodPathReturns
readGET/Medication/{id}A single Medication resource

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Medication/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Organizationread

Interactions

FunctionMethodPathReturns
readGET/Organization/{id}A single Organization resource

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Organization/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Practitionerread

Interactions

FunctionMethodPathReturns
readGET/Practitioner/{id}A single Practitioner resource

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Practitioner/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
PractitionerRolereadsearch-type

Interactions

FunctionMethodPathReturns
readGET/PractitionerRole/{id}A single PractitionerRole resource
search-typeGET/PractitionerRole?{parameters}A Bundle of type searchset
search-typePOST/PractitionerRole/_searchA Bundle of type searchset

Search parameters

ParameterData typeRequiredNotes
_idtokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.
practitionerreferenceOptionalA reference to another resource, given as a bare logical id or as Type/id.
specialtytokenOptionalA coded value. Either a bare code, or system|code to qualify it by code system.

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/PractitionerRole?_id=" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Provenanceread

Interactions

FunctionMethodPathReturns
readGET/Provenance/{id}A single Provenance resource

Supported profiles

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Provenance/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"
Group

Interactions

FunctionMethodPathReturns

Example request

Binaryread

Interactions

FunctionMethodPathReturns
readGET/Binary/{id}A single Binary resource

Example request

curl -X GET "https://fhir.maximus.care/api/r4/Binary/{id}" \
  -H "Authorization: Bearer <access_token>" \
  -H "Accept: application/fhir+json"

Last updated 18 November 2026

Maximus EHR — documentation published for the ONC Health IT Certification Program.

See the API terms and conditions. Where this documentation and the Maximus EHR listing on the ONC Certified Health IT Product List differ, the CHPL listing governs.

© 2026 MaxRemind Inc. All rights reserved.