Developer API Documentation

Welcome to the developer portal for the NXPH FHIR Facade. This guide provides interactive, standards-compliant documentation for integrates, EHR clients, and third-party app developers using our certified health IT standards.

ONC (g)(10) Standardized API: The NXPH FHIR Facade is fully designed to comply with the ONC Cures Act 170.315(g)(10) certification criteria. It supports SMART-on-FHIR Single Patient Launch, Backend Services Bulk Data Access, and conforms strictly to the HL7 FHIR R4 (v4.0.1) and US Core Implementation Guide (v3.1.1, v4.0.0, and v6.1.0).

System Overview

The NXPH FHIR Facade is built using a secure Ports-and-Adapters (Hexagonal) Architecture. It sits transparently in front of Keycloak (serving as the secure Identity Provider and OAuth 2.0 Authorization Server) and dynamically translates inbound FHIR resource requests, performs context evaluation, enforces patient-level access boundaries, and compiles standard responses dynamically.

Base URLs & Discovery FHIR R4

Before launching queries or requesting access tokens, developers must query our discovery endpoints. Below are the production base URLs configured for access:

Service Name Standard Protocol Production Base URL
FHIR R4 Facade API HL7 FHIR R4 (v4.0.1) https://fhir.nexapointhealth.com/fhir/r4
OAuth 2.0 / Keycloak Server SMART-on-FHIR v1 & v2 https://fhir.nexapointhealth.com/auth

SMART Configuration Discovery

Our server exposes a public, unauthenticated SMART configuration discovery document under the standard well-known location. Third-party applications must dynamically retrieve the authorize, token, and revocation endpoints from this document:

GET /fhir/r4/.well-known/smart-configuration

Returns SMART configuration URLs, supported scopes, and launch profiles.

Response Example (JSON){
  "issuer": "https://fhir.nexapointhealth.com/realms/nxph",
  "jwks_uri": "https://fhir.nexapointhealth.com/realms/nxph/protocol/openid-connect/certs",
  "authorization_endpoint": "https://fhir.nexapointhealth.com/auth/authorize",
  "token_endpoint": "https://fhir.nexapointhealth.com/auth/token",
  "introspection_endpoint": "https://fhir.nexapointhealth.com/auth/introspect",
  "revocation_endpoint": "https://fhir.nexapointhealth.com/auth/revoke",
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post"
  ],
  "grant_types_supported": [
    "authorization_code",
    "client_credentials"
  ],
  "scopes_supported": [
    "openid", "fhirUser", "launch", "launch/patient", "offline_access",
    "patient/*.read", "patient/*.write", "user/*.read", "user/*.write",
    "system/*.read", "system/*.write", "system/*.*",
    "patient/Patient.rs", "patient/Observation.rs", "patient/Condition.rs"
  ],
  "capabilities": [
    "launch-standalone",
    "launch-ehr",
    "client-confidential-symmetric",
    "client-confidential-asymmetric",
    "permission-v2"
  ],
  "code_challenge_methods_supported": ["S256"]
}

Conformance & CapabilityStatement

The CapabilityStatement provides a strict metadata description of all supported resources, operations, search parameters, and security configurations. Developers can query it publicly at any time:

GET /fhir/r4/metadata

Retrieves the server's CapabilityStatement describing compliance and supported resources.

USCDI v3 Mapping: All clinical resources are designed to resolve to their respective US Core profiles. For instance, observations are dynamically mapped to laboratory, vital-signs, social-history, or SDOH clinical result profiles depending on category query parameters.

Authentication & SMART-on-FHIR

The NXPH FHIR Facade enforces OAuth 2.0 authorization codes and token exchanges. It supports both standalone launch configurations for patient-facing applications and asymmetric backend system authentication (`private_key_jwt`) for clinic-wide bulk data extraction.

Auth Type Target Use Case OAuth Grant Flow Credentials Requirement
Standalone Patient Launch Individual Patient Portal Apps authorization_code (with PKCE) Confidential Symmetric Client Secret
Backend Service Export Bulk Data extract / Population health client_credentials Asymmetric Private Key JWT (`RS384` signed)

Standalone Patient Launch User Flow

The standalone SMART launch flow enables third-party client apps to authorize access to an individual patient's records securely using PKCE (Proof Key for Code Exchange).

App Initiates Authorize Call: Redirects the user's browser to /auth/authorize. Must include the exact aud (FHIR Audience URL matching our base URL), client ID, PKCE challenges, redirect URI, and scopes.
Dynamic SMART Consent Screen: The user chooses which US Core resource scopes to grant access to (e.g. read-only conditions, lab reports, or allergies).
Keycloak Redirect: Consent selections are sent to Keycloak for credentials validation. User completes authentication.
Auth Code Grant & Exchange: Browser redirects to the client application with an authorization code.
Token Augmentation: Client application exchanges the authorization code for an access token via POST /auth/token. The facade intercepts the response and injects the SMART launch context (such as patient: "example-1").

1. Initial Authorize Request

The redirect URI must match what you registered in the developer portal. The aud parameter is strictly validated by the server and must exactly match the FHIR R4 base URL:

# HTTP GET Request to /auth/authorize
GET /auth/authorize?
  response_type=code
  &client_id=my-app-client
  &redirect_uri=https%3A%2F%2Fmyapp.com%2Fcallback
  &scope=openid%20fhirUser%20launch%2Fpatient%20patient%2FPatient.rs%20patient%2FObservation.rs
  &state=xyzState123
  &aud=https%3A%2F%2Ffhir.nexapointhealth.com%2Ffhir%2Fr4
  &code_challenge=E9Melhoa2OwvFrGMTJguCH5yOF4g9tUAg-by3dgJW3E
  &code_challenge_method=S256 HTTP/1.1
Host: fhir.nexapointhealth.com

2. Exchanging the Authorization Code for an Access Token

Submit a form-encoded payload to /auth/token. For confidential symmetric clients, you must pass your credentials or use standard Basic Auth header:

# HTTP POST Request to /auth/token
POST /auth/token HTTP/1.1
Host: fhir.nexapointhealth.com
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&code=SplxlOBeZQQYbYS6WxSbIA
&redirect_uri=https%3A%2F%2Fmyapp.com%2Fcallback
&client_id=my-app-client
&client_secret=super_secret_symmetric_secret_key
&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk

Upon success, the server responds with a decorated SMART token payload. Crucially, the patient context is resolved and returned in the top-level JSON response:

Token Response (JSON){
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6IC...",
  "expires_in": 300,
  "refresh_expires_in": 1800,
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lk...",
  "token_type": "Bearer",
  "scope": "openid fhirUser launch/patient patient/Patient.rs patient/Observation.rs",
  "patient": "example-1",
  "fhirUser": "Practitioner/example-1",
  "need_patient_banner": true,
  "smart_style_url": "https://fhir.nexapointhealth.com/smart-style.json"
}

Backend Services & Asymmetric Auth

For system-level data synchronization and Bulk FHIR Exports, the server implements Asymmetric Client Authentication (RFC 7523 / private_key_jwt). System clients do not use client secrets. Instead, they register a public JWKS key URL in our administration dashboard and authenticate by presenting a signed, short-lived JSON Web Token.

Asymmetric Cryptography Requirement: Client assertions must be signed using RS384, RS512, or ES384 private keys. The assertion token must not exceed 5 minutes in lifespan, and must contain a unique jti (JWT ID) to mitigate replay attacks.

Sample Client JWT Assertion Payload

The token must be signed by your private key, and contain standard registration claims. Note that the audience claim (aud) must point exactly to our token authorization proxy endpoint:

Decoded JWT Assertion Payload{
  "iss": "my-registered-vendor-client-id",
  "sub": "my-registered-vendor-client-id",
  "aud": "https://fhir.nexapointhealth.com/auth/token",
  "jti": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "exp": 1779344400, // 5 minutes maximum expiration
  "iat": 1779344100
}

Requesting a Bulk Token

To request a token, execute a `POST` request with the grant type set to client_credentials and pass the signed client assertion payload:

# HTTP POST Request for Bulk Authentication
POST /auth/token HTTP/1.1
Host: fhir.nexapointhealth.com
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajtf-bearer
&client_assertion=eyJhbGciOiJSUzM4NCIsInR5cCI6IkpXVCIsImtpZCI6IjEyMyJ9.ey...

Granular SMART v1 & v2 Scopes

The NXPH FHIR Facade implements a strict scope enforcement engine. It natively parses and validates both **SMART v1 wildcard scopes** (e.g. patient/*.read) and **SMART v2 granular resource scopes** containing category filtering parameters (e.g. patient/Observation.rs?category=laboratory).

Scope Notation Target Category Constraint Permitted FHIR Operations
patient/Patient.rs All Patients Read, Search-Type
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|laboratory Laboratory Results Only Read, Search-Type (restricted category)
patient/Observation.rs?category=http://terminology.hl7.org/CodeSystem/observation-category|vital-signs Vital Signs Records Only Read, Search-Type (restricted category)
patient/Condition.rs?category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item Problem Lists Only Read, Search-Type (restricted category)
system/*.read System-Level Export All Bulk Data operations
Translation Layer: If the user approves a granular scope containing a filter, our database query engine automatically intercepts search operations and injects the category values directly into the query, preventing data leakage outside authorized bounds.

Token Introspection & Revocation

For maximum enterprise security, client applications and auditing microservices can dynamically query token status or proactively revoke active refresh tokens and grant credentials.

Token Introspection (RFC 7662)

Used to verify the cryptographic validity, active status, scopes, and context linked to a token:

POST /auth/introspect

Retrieves token status and active metadata.

# HTTP POST to /auth/introspect
POST /auth/introspect HTTP/1.1
Host: fhir.nexapointhealth.com
Content-Type: application/x-www-form-urlencoded
Authorization: Basic bXktYXBwLWNsaWVudDpzdXBlcl9zZWNyZXRfc3ltbWV0cmljX3NlY3JldF9rZXk=

token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6IC...

Token Revocation (RFC 7009)

Instantly revokes access and refresh tokens. Locally flagged tokens immediately block downstream clinical requests:

POST /auth/revoke

Invalidates the provided token or entire login session.

# HTTP POST to /auth/revoke
POST /auth/revoke HTTP/1.1
Host: fhir.nexapointhealth.com
Content-Type: application/x-www-form-urlencoded

client_id=my-app-client
&client_secret=super_secret_symmetric_secret_key
&token=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6IC...

Patient Resource Endpoints

The patient search and read APIs conform strictly to the US Core Patient profile. Support is provided for single-patient reads, searches by demographic identifiers, and conditional fetches.

GET Patient - Read by ID

This resource conforms to the USCDI profile for Patient Demographics - refer to the US Core Patient Profile. Patient resource responses are returned in high-fidelity JSON format as per the HL7 FHIR standard R4 version.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active SMART access token containing patient isolation context. Authorized scopes must contain patient/Patient.read or patient/Patient.rs.

GET https://fhir.nexapointhealth.com/fhir/r4/Patient/example
Parameters
id string <example>
Example Request Read by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Patient/example
Example Response 200 OK
Body
Headers (5)
json 
{
  "resourceType": "Patient",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;"><b>Amy V. Baxter </b> female, DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: USUAL))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Record is active">Active:</td><td colspan="3">true</td></tr><tr><td style="background-color: #f3f5da" title="Alternate names (see the one above)">Alt. Name:</td><td colspan="3">Amy V. Shaw (OLD)</td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Details:</td><td colspan="3"><ul><li>ph: 555-555-5555(HOME)</li><li><a href="mailto:amy.shaw@example.com">amy.shaw@example.com</a></li><li>49 Meadow St Mounds OK 74047 US (OLD)</li><li>183 Mountain View St Mounds OK 74048 US </li></ul></td></tr><tr><td style="background-color: #f3f5da" title="The Sex Extension is used to reflect the documentation of a person's sex. Systems choosing to record sources of information should use the [Provenance resource](basic-provenance.html#element-level-provenance).
 
USCDI v3 includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This Sex extension supports USCDI v3. Sex assigned at birth or birth sex can be recorded using the more specific [US Core Birth Sex Extension](http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex).
Future versions of this extension may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on its relationship to administrative gender ([Patient.gender](StructureDefinition-us-core-patient-definitions.html#Patient.gender))."><a href="StructureDefinition-us-core-sex.html">US Core Sex Extension:</a></td><td colspan="3"><ul><li>248152002</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity.  The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.">US Core Ethnicity Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2135-2">CDC Race and Ethnicity</a> 2135-2: Hispanic or Latino</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2184-0">CDC Race and Ethnicity</a> 2184-0: Dominican</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2148-5">CDC Race and Ethnicity</a> 2148-5: Mexican</li><li>text: Hispanic or Latino</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="A code classifying the person's sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). After version 6.0.0, this extension is no longer a *USCDI Requirement*."><a href="StructureDefinition-us-core-birthsex.html">US Core Birth Sex Extension:</a></td><td colspan="3"><ul><li>F</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html#3) which includes over 900 concepts for representing race and ethnicity of which 921 reference race.  The race concepts are grouped by and pre-mapped to the 5 OMB race categories:
 
 - American Indian or Alaska Native
 - Asian
 - Black or African American
 - Native Hawaiian or Other Pacific Islander
 - White.">US Core Race Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2106-3">CDC Race and Ethnicity</a> 2106-3: White</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1002-5">CDC Race and Ethnicity</a> 1002-5: American Indian or Alaska Native</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2028-9">CDC Race and Ethnicity</a> 2028-9: Asian</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1586-7">CDC Race and Ethnicity</a> 1586-7: Shoshone</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2036-2">CDC Race and Ethnicity</a> 2036-2: Filipino</li><li>text: Mixed</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.">US Core Tribal Affiliation Extension:</td><td colspan="3"><ul><li>tribalAffiliation: <span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS 187}">Shoshone</span></li><li>isEnrolled: false</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension."><a href="StructureDefinition-us-core-genderIdentity.html">US Core Gender Identity Extension:</a></td><td colspan="3"><ul><li><span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-NullFlavor UNK}">Unknown</span></li></ul></td></tr></table></div>"
  },
  "extension": [
    {
      "extension": [
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2106-3",
            "display": "White"
          }
        },
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "1002-5",
            "display": "American Indian or Alaska Native"
          }
        },
        {
          "url": "ombCategory",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2028-9",
            "display": "Asian"
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "1586-7",
            "display": "Shoshone"
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2036-2",
            "display": "Filipino"
          }
        },
        {
          "url": "text",
          "valueString": "Mixed"
        }
      ],
      "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": "detailed",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2184-0",
            "display": "Dominican"
          }
        },
        {
          "url": "detailed",
          "valueCoding": {
            "system": "urn:oid:2.16.840.1.113883.6.238",
            "code": "2148-5",
            "display": "Mexican"
          }
        },
        {
          "url": "text",
          "valueString": "Hispanic or Latino"
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
    },
    {
      "extension": [
        {
          "url": "tribalAffiliation",
          "valueCodeableConcept": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                "code": "187",
                "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
              }
            ],
            "text": "Shoshone"
          }
        },
        {
          "url": "isEnrolled",
          "valueBoolean": false
        }
      ],
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
      "valueCode": "F"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
      "valueCode": "248152002"
    },
    {
      "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
            "code": "UNK",
            "display": "Unknown"
          }
        ],
        "text": "Unknown"
      }
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "MR",
            "display": "Medical Record Number"
          }
        ],
        "text": "Medical Record Number"
      },
      "system": "http://hospital.smarthealthit.org",
      "value": "1032702"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "old",
      "family": "Shaw",
      "given": [
        "Amy",
        "V."
      ],
      "period": {
        "start": "2016-12-06",
        "end": "2020-07-22"
      }
    },
    {
      "family": "Baxter",
      "given": [
        "Amy",
        "V."
      ],
      "suffix": [
        "PharmD"
      ],
      "period": {
        "start": "2020-07-22"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "555-555-5555",
      "use": "home"
    },
    {
      "system": "email",
      "value": "amy.shaw@example.com"
    }
  ],
  "gender": "female",
  "birthDate": "1987-02-20",
  "address": [
    {
      "use": "old",
      "line": [
        "49 Meadow St"
      ],
      "city": "Mounds",
      "state": "OK",
      "postalCode": "74047",
      "country": "US",
      "period": {
        "start": "2016-12-06",
        "end": "2020-07-22"
      }
    },
    {
      "line": [
        "183 Mountain View St"
      ],
      "city": "Mounds",
      "state": "OK",
      "postalCode": "74048",
      "country": "US",
      "period": {
        "start": "2020-07-22"
      }
    }
  ]
}

GET Patient - Search by Parameter

Searches patient records using demographic matching keys. Multiple filters are evaluated in a logical AND sequence to refine patient search targets.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer context. Restricted by the user's patient-isolation index boundary.

GET https://fhir.nexapointhealth.com/fhir/r4/Patient?identifier=http://hospital.smarthealthit.org|1032702
PARAMS
_id token <example>
identifier token <http://hospital.smarthealthit.org|1032702>
birthdate date <1987-02-20>
gender token <female>
name string <Amy>
_revinclude string <Provenance:target>
Example Request Search by Identifier
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Patient?identifier=http://hospital.smarthealthit.org|1032702"
Example Response 200 OK
Body
Headers (6)
json 
{
  "resourceType": "Bundle",
  "id": "7ca6c1e5-827c-473d-9d7a-c1143899326e",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Patient?identifier=http://hospital.smarthealthit.org|1032702"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Patient/example",
      "resource": {
        "resourceType": "Patient",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;"><b>Amy V. Baxter </b> female, DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: USUAL))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Record is active">Active:</td><td colspan="3">true</td></tr><tr><td style="background-color: #f3f5da" title="Alternate names (see the one above)">Alt. Name:</td><td colspan="3">Amy V. Shaw (OLD)</td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Details:</td><td colspan="3"><ul><li>ph: 555-555-5555(HOME)</li><li><a href="mailto:amy.shaw@example.com">amy.shaw@example.com</a></li><li>49 Meadow St Mounds OK 74047 US (OLD)</li><li>183 Mountain View St Mounds OK 74048 US </li></ul></td></tr><tr><td style="background-color: #f3f5da" title="The Sex Extension is used to reflect the documentation of a person's sex. Systems choosing to record sources of information should use the [Provenance resource](basic-provenance.html#element-level-provenance).
 
USCDI v3 includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This Sex extension supports USCDI v3. Sex assigned at birth or birth sex can be recorded using the more specific [US Core Birth Sex Extension](http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex).
Future versions of this extension may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on its relationship to administrative gender ([Patient.gender](StructureDefinition-us-core-patient-definitions.html#Patient.gender))."><a href="StructureDefinition-us-core-sex.html">US Core Sex Extension:</a></td><td colspan="3"><ul><li>248152002</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity.  The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.">US Core Ethnicity Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2135-2">CDC Race and Ethnicity</a> 2135-2: Hispanic or Latino</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2184-0">CDC Race and Ethnicity</a> 2184-0: Dominican</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2148-5">CDC Race and Ethnicity</a> 2148-5: Mexican</li><li>text: Hispanic or Latino</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="A code classifying the person's sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). After version 6.0.0, this extension is no longer a *USCDI Requirement*."><a href="StructureDefinition-us-core-birthsex.html">US Core Birth Sex Extension:</a></td><td colspan="3"><ul><li>F</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html#3) which includes over 900 concepts for representing race and ethnicity of which 921 reference race.  The race concepts are grouped by and pre-mapped to the 5 OMB race categories:
 
 - American Indian or Alaska Native
 - Asian
 - Black or African American
 - Native Hawaiian or Other Pacific Islander
 - White.">US Core Race Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2106-3">CDC Race and Ethnicity</a> 2106-3: White</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1002-5">CDC Race and Ethnicity</a> 1002-5: American Indian or Alaska Native</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2028-9">CDC Race and Ethnicity</a> 2028-9: Asian</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1586-7">CDC Race and Ethnicity</a> 1586-7: Shoshone</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2036-2">CDC Race and Ethnicity</a> 2036-2: Filipino</li><li>text: Mixed</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.">US Core Tribal Affiliation Extension:</td><td colspan="3"><ul><li>tribalAffiliation: <span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS 187}">Shoshone</span></li><li>isEnrolled: false</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension."><a href="StructureDefinition-us-core-genderIdentity.html">US Core Gender Identity Extension:</a></td><td colspan="3"><ul><li><span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-NullFlavor UNK}">Unknown</span></li></ul></td></tr></table></div>"
        },
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "1002-5",
                  "display": "American Indian or Alaska Native"
                }
              },
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2028-9",
                  "display": "Asian"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "1586-7",
                  "display": "Shoshone"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2036-2",
                  "display": "Filipino"
                }
              },
              {
                "url": "text",
                "valueString": "Mixed"
              }
            ],
            "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": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2184-0",
                  "display": "Dominican"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2148-5",
                  "display": "Mexican"
                }
              },
              {
                "url": "text",
                "valueString": "Hispanic or Latino"
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
          },
          {
            "extension": [
              {
                "url": "tribalAffiliation",
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                      "code": "187",
                      "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                    }
                  ],
                  "text": "Shoshone"
                }
              },
              {
                "url": "isEnrolled",
                "valueBoolean": false
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "F"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
            "valueCode": "248152002"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                  "code": "UNK",
                  "display": "Unknown"
                }
              ],
              "text": "Unknown"
            }
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "MR",
                  "display": "Medical Record Number"
                }
              ],
              "text": "Medical Record Number"
            },
            "system": "http://hospital.smarthealthit.org",
            "value": "1032702"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "old",
            "family": "Shaw",
            "given": [
              "Amy",
              "V."
            ],
            "period": {
              "start": "2016-12-06",
              "end": "2020-07-22"
            }
          },
          {
            "family": "Baxter",
            "given": [
              "Amy",
              "V."
            ],
            "suffix": [
              "PharmD"
            ],
            "period": {
              "start": "2020-07-22"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-555-5555",
            "use": "home"
          },
          {
            "system": "email",
            "value": "amy.shaw@example.com"
          }
        ],
        "gender": "female",
        "birthDate": "1987-02-20",
        "address": [
          {
            "use": "old",
            "line": [
              "49 Meadow St"
            ],
            "city": "Mounds",
            "state": "OK",
            "postalCode": "74047",
            "country": "US",
            "period": {
              "start": "2016-12-06",
              "end": "2020-07-22"
            }
          },
          {
            "line": [
              "183 Mountain View St"
            ],
            "city": "Mounds",
            "state": "OK",
            "postalCode": "74048",
            "country": "US",
            "period": {
              "start": "2020-07-22"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Patient - Search by Parameter

Searches patient records using demographic matching keys with parameters passed securely inside a URL-encoded POST body. Useful for long queries or to avoid caching identifiers in web logs.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer context. Restricted by the user's patient-isolation index boundary.

POST https://fhir.nexapointhealth.com/fhir/r4/Patient/_search
HEADERS
Content-Type string <application/x-www-form-urlencoded>
BODY PARAMETERS
identifier token <http://hospital.smarthealthit.org|1032702>
birthdate date <1987-02-20>
gender token <female>
name string <Amy>
_revinclude string <Provenance:target>
Example Request POST Search by Identifier
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Patient/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "identifier=http://hospital.smarthealthit.org|1032702"
Example Response 200 OK
Body
Headers (6)
json 
{
  "resourceType": "Bundle",
  "id": "7ca6c1e5-827c-473d-9d7a-c1143899326e",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Patient?identifier=http://hospital.smarthealthit.org|1032702"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Patient/example",
      "resource": {
        "resourceType": "Patient",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p style="border: 1px #661aff solid; background-color: #e6e6ff; padding: 10px;"><b>Amy V. Baxter </b> female, DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: USUAL))</p><hr/><table class="grid"><tr><td style="background-color: #f3f5da" title="Record is active">Active:</td><td colspan="3">true</td></tr><tr><td style="background-color: #f3f5da" title="Alternate names (see the one above)">Alt. Name:</td><td colspan="3">Amy V. Shaw (OLD)</td></tr><tr><td style="background-color: #f3f5da" title="Ways to contact the Patient">Contact Details:</td><td colspan="3"><ul><li>ph: 555-555-5555(HOME)</li><li><a href="mailto:amy.shaw@example.com">amy.shaw@example.com</a></li><li>49 Meadow St Mounds OK 74047 US (OLD)</li><li>183 Mountain View St Mounds OK 74048 US </li></ul></td></tr><tr><td style="background-color: #f3f5da" title="The Sex Extension is used to reflect the documentation of a person's sex. Systems choosing to record sources of information should use the [Provenance resource](basic-provenance.html#element-level-provenance).
 
USCDI v3 includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This Sex extension supports USCDI v3. Sex assigned at birth or birth sex can be recorded using the more specific [US Core Birth Sex Extension](http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex).
Future versions of this extension may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on its relationship to administrative gender ([Patient.gender](StructureDefinition-us-core-patient-definitions.html#Patient.gender))."><a href="StructureDefinition-us-core-sex.html">US Core Sex Extension:</a></td><td colspan="3"><ul><li>248152002</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity.  The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.">US Core Ethnicity Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2135-2">CDC Race and Ethnicity</a> 2135-2: Hispanic or Latino</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2184-0">CDC Race and Ethnicity</a> 2184-0: Dominican</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2148-5">CDC Race and Ethnicity</a> 2148-5: Mexican</li><li>text: Hispanic or Latino</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="A code classifying the person's sex assigned at birth  as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). This extension aligns with the C-CDA Birth Sex Observation (LOINC 76689-9). After version 6.0.0, this extension is no longer a *USCDI Requirement*."><a href="StructureDefinition-us-core-birthsex.html">US Core Birth Sex Extension:</a></td><td colspan="3"><ul><li>F</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.  The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html#3) which includes over 900 concepts for representing race and ethnicity of which 921 reference race.  The race concepts are grouped by and pre-mapped to the 5 OMB race categories:
 
 - American Indian or Alaska Native
 - Asian
 - Black or African American
 - Native Hawaiian or Other Pacific Islander
 - White.">US Core Race Extension:</td><td colspan="3"><ul><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2106-3">CDC Race and Ethnicity</a> 2106-3: White</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1002-5">CDC Race and Ethnicity</a> 1002-5: American Indian or Alaska Native</li><li>ombCategory: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2028-9">CDC Race and Ethnicity</a> 2028-9: Asian</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-1586-7">CDC Race and Ethnicity</a> 1586-7: Shoshone</li><li>detailed: <a href="http://terminology.hl7.org/5.0.0/CodeSystem-CDCREC.html#CDCREC-2036-2">CDC Race and Ethnicity</a> 2036-2: Filipino</li><li>text: Mixed</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This Extension profile represents a tribe or band with which a person associates and, optionally, whether they are enrolled.">US Core Tribal Affiliation Extension:</td><td colspan="3"><ul><li>tribalAffiliation: <span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS 187}">Shoshone</span></li><li>isEnrolled: false</li></ul></td></tr><tr><td style="background-color: #f3f5da" title="This extension represents an individual's sense of being a man, woman, boy, girl, nonbinary, or something else, ascertained by asking them what that identity is. Systems requiring multiple gender identities and associated dates **SHOULD** use the FHIR R5 [genderIdentity extension](http://hl7.org/fhir/extensions/StructureDefinition-individual-genderIdentity.html). When future versions of US Core are based on FHIR R5, the FHIR R5 extension will supersede this extension."><a href="StructureDefinition-us-core-genderIdentity.html">US Core Gender Identity Extension:</a></td><td colspan="3"><ul><li><span title="Codes: {http://terminology.hl7.org/CodeSystem/v3-NullFlavor UNK}">Unknown</span></li></ul></td></tr></table></div>"
        },
        "extension": [
          {
            "extension": [
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2106-3",
                  "display": "White"
                }
              },
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "1002-5",
                  "display": "American Indian or Alaska Native"
                }
              },
              {
                "url": "ombCategory",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2028-9",
                  "display": "Asian"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "1586-7",
                  "display": "Shoshone"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2036-2",
                  "display": "Filipino"
                }
              },
              {
                "url": "text",
                "valueString": "Mixed"
              }
            ],
            "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": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2184-0",
                  "display": "Dominican"
                }
              },
              {
                "url": "detailed",
                "valueCoding": {
                  "system": "urn:oid:2.16.840.1.113883.6.238",
                  "code": "2148-5",
                  "display": "Mexican"
                }
              },
              {
                "url": "text",
                "valueString": "Hispanic or Latino"
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
          },
          {
            "extension": [
              {
                "url": "tribalAffiliation",
                "valueCodeableConcept": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/v3-TribalEntityUS",
                      "code": "187",
                      "display": "Paiute-Shoshone Tribe of the Fallon Reservation and Colony, Nevada"
                    }
                  ],
                  "text": "Shoshone"
                }
              },
              {
                "url": "isEnrolled",
                "valueBoolean": false
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "F"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex",
            "valueCode": "248152002"
          },
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                  "code": "UNK",
                  "display": "Unknown"
                }
              ],
              "text": "Unknown"
            }
          }
        ],
        "identifier": [
          {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "MR",
                  "display": "Medical Record Number"
                }
              ],
              "text": "Medical Record Number"
            },
            "system": "http://hospital.smarthealthit.org",
            "value": "1032702"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "old",
            "family": "Shaw",
            "given": [
              "Amy",
              "V."
            ],
            "period": {
              "start": "2016-12-06",
              "end": "2020-07-22"
            }
          },
          {
            "family": "Baxter",
            "given": [
              "Amy",
              "V."
            ],
            "suffix": [
              "PharmD"
            ],
            "period": {
              "start": "2020-07-22"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-555-5555",
            "use": "home"
          },
          {
            "system": "email",
            "value": "amy.shaw@example.com"
          }
        ],
        "gender": "female",
        "birthDate": "1987-02-20",
        "address": [
          {
            "use": "old",
            "line": [
              "49 Meadow St"
            ],
            "city": "Mounds",
            "state": "OK",
            "postalCode": "74047",
            "country": "US",
            "period": {
              "start": "2016-12-06",
              "end": "2020-07-22"
            }
          },
          {
            "line": [
              "183 Mountain View St"
            ],
            "city": "Mounds",
            "state": "OK",
            "postalCode": "74048",
            "country": "US",
            "period": {
              "start": "2020-07-22"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

AllergyIntolerance Resource Endpoints

The AllergyIntolerance API conforms to the US Core AllergyIntolerance Profile, providing access to patient allergy and intolerance records.

GET AllergyIntolerance - Read by ID

Retrieves a specific allergyintolerance record by its logical ID. Requires patient/AllergyIntolerance.read or patient/AllergyIntolerance.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "AllergyIntolerance",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
    ]
  },
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "active",
        "display": "Active"
      }
    ],
    "text": "Active"
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "category": [
    "medication"
  ],
  "criticality": "high",
  "code": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "7980",
        "display": "Penicillin G"
      }
    ],
    "text": "Penicillin"
  },
  "patient": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "onsetDateTime": "2010-05-12",
  "recordedDate": "2023-03-14T10:00:00-05:00",
  "recorder": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  },
  "asserter": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "reaction": [
    {
      "substance": {
        "coding": [
          {
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
            "code": "7980",
            "display": "Penicillin G"
          }
        ]
      },
      "manifestation": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "247472004",
              "display": "Hives"
            }
          ],
          "text": "Hives"
        }
      ],
      "description": "Severe whole-body hives within 30 minutes of administration",
      "onset": "2010-05-12",
      "severity": "severe"
    }
  ]
}

GET AllergyIntolerance - Search by Parameter

Searches allergyintolerance resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance?patient=example&clinical-status=active
Parameters
patientreference<example>
clinical-statustoken<active|inactive|resolved>
Example RequestSearch Active Allergies
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance?patient=example&clinical-status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-a8b3a961",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance?patient=example&clinical-status=active"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/example",
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ],
          "text": "Active"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          "medication"
        ],
        "criticality": "high",
        "code": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "7980",
              "display": "Penicillin G"
            }
          ],
          "text": "Penicillin"
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "onsetDateTime": "2010-05-12",
        "recordedDate": "2023-03-14T10:00:00-05:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "asserter": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "reaction": [
          {
            "substance": {
              "coding": [
                {
                  "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                  "code": "7980",
                  "display": "Penicillin G"
                }
              ]
            },
            "manifestation": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "247472004",
                    "display": "Hives"
                  }
                ],
                "text": "Hives"
              }
            ],
            "description": "Severe whole-body hives within 30 minutes of administration",
            "onset": "2010-05-12",
            "severity": "severe"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST AllergyIntolerance - Search by Parameter

Searches allergyintolerance resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
clinical-statustoken<active>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "clinical-status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-8fbda20f",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/AllergyIntolerance/example",
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ],
          "text": "Active"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          "medication"
        ],
        "criticality": "high",
        "code": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "7980",
              "display": "Penicillin G"
            }
          ],
          "text": "Penicillin"
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "onsetDateTime": "2010-05-12",
        "recordedDate": "2023-03-14T10:00:00-05:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "asserter": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "reaction": [
          {
            "substance": {
              "coding": [
                {
                  "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
                  "code": "7980",
                  "display": "Penicillin G"
                }
              ]
            },
            "manifestation": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "247472004",
                    "display": "Hives"
                  }
                ],
                "text": "Hives"
              }
            ],
            "description": "Severe whole-body hives within 30 minutes of administration",
            "onset": "2010-05-12",
            "severity": "severe"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

CarePlan Resource Endpoints

The CarePlan API conforms to the US Core CarePlan Profile, providing access to patient assessment and plan of treatment.

GET CarePlan - Read by ID

Retrieves a specific careplan record by its logical ID. Requires patient/CarePlan.read or patient/CarePlan.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/CarePlan/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/CarePlan/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "CarePlan",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "additional",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml">Assessment and Plan</div>"
  },
  "status": "active",
  "intent": "plan",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "period": {
    "start": "2024-01-15"
  },
  "created": "2024-01-15T09:30:00-05:00",
  "author": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  },
  "description": "Type 2 diabetes mellitus management plan including lifestyle modification and pharmacotherapy."
}

GET CarePlan - Search by Parameter

Searches careplan resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/CarePlan?patient=example&category=assess-plan
Parameters
patientreference<example>
categorytoken<assess-plan>
Example RequestSearch Assessment Plans
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/CarePlan?patient=example&category=assess-plan"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-7bbaa6b9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/CarePlan?patient=example&category=assess-plan"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/CarePlan/example",
      "resource": {
        "resourceType": "CarePlan",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "additional",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml">Assessment and Plan</div>"
        },
        "status": "active",
        "intent": "plan",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "period": {
          "start": "2024-01-15"
        },
        "created": "2024-01-15T09:30:00-05:00",
        "author": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "description": "Type 2 diabetes mellitus management plan including lifestyle modification and pharmacotherapy."
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST CarePlan - Search by Parameter

Searches careplan resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/CarePlan/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<assess-plan>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/CarePlan/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=assess-plan"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-d8dabc59",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/CarePlan/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/CarePlan/example",
      "resource": {
        "resourceType": "CarePlan",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "additional",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml">Assessment and Plan</div>"
        },
        "status": "active",
        "intent": "plan",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "period": {
          "start": "2024-01-15"
        },
        "created": "2024-01-15T09:30:00-05:00",
        "author": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "description": "Type 2 diabetes mellitus management plan including lifestyle modification and pharmacotherapy."
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

CareTeam Resource Endpoints

The CareTeam API conforms to the US Core CareTeam Profile, identifying the practitioners and roles involved in the care of a patient.

GET CareTeam - Read by ID

Retrieves a specific careteam record by its logical ID. Requires patient/CareTeam.read or patient/CareTeam.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/CareTeam/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/CareTeam/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "CareTeam",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
    ]
  },
  "status": "active",
  "name": "Diabetes Care Team",
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "period": {
    "start": "2024-01-15"
  },
  "participant": [
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://nucc.org/provider-taxonomy",
              "code": "207RE0101X",
              "display": "Endocrinology"
            }
          ],
          "text": "Endocrinologist"
        }
      ],
      "member": {
        "reference": "Practitioner/practitioner-1",
        "display": "Dr. Ronald Bone"
      }
    },
    {
      "role": [
        {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "116154003",
              "display": "Patient"
            }
          ],
          "text": "Patient"
        }
      ],
      "member": {
        "reference": "Patient/example",
        "display": "Amy V. Baxter"
      }
    }
  ]
}

GET CareTeam - Search by Parameter

Searches careteam resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/CareTeam?patient=example&status=active
Parameters
patientreference<example>
statustoken<active>
Example RequestSearch Active Teams
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/CareTeam?patient=example&status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-4d1cb9dc",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/CareTeam?patient=example&status=active"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/CareTeam/example",
      "resource": {
        "resourceType": "CareTeam",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
          ]
        },
        "status": "active",
        "name": "Diabetes Care Team",
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "period": {
          "start": "2024-01-15"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://nucc.org/provider-taxonomy",
                    "code": "207RE0101X",
                    "display": "Endocrinology"
                  }
                ],
                "text": "Endocrinologist"
              }
            ],
            "member": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          },
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "116154003",
                    "display": "Patient"
                  }
                ],
                "text": "Patient"
              }
            ],
            "member": {
              "reference": "Patient/example",
              "display": "Amy V. Baxter"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST CareTeam - Search by Parameter

Searches careteam resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/CareTeam/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
statustoken<active>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/CareTeam/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-32fa754e",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/CareTeam/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/CareTeam/example",
      "resource": {
        "resourceType": "CareTeam",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
          ]
        },
        "status": "active",
        "name": "Diabetes Care Team",
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "period": {
          "start": "2024-01-15"
        },
        "participant": [
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://nucc.org/provider-taxonomy",
                    "code": "207RE0101X",
                    "display": "Endocrinology"
                  }
                ],
                "text": "Endocrinologist"
              }
            ],
            "member": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          },
          {
            "role": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "116154003",
                    "display": "Patient"
                  }
                ],
                "text": "Patient"
              }
            ],
            "member": {
              "reference": "Patient/example",
              "display": "Amy V. Baxter"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Condition (Encounter Diagnosis) Resource Endpoints

Conforms to the US Core Condition Encounter Diagnosis Profile. Returns diagnoses recorded in the context of a specific encounter (visit-level diagnoses).

GET Condition - Encounter Diagnosis - Read by ID

Retrieves a specific condition record by its logical ID. Requires patient/Condition.read or patient/Condition.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Condition/encounter-diagnosis-example
Parameters
idstring<encounter-diagnosis-example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Condition/encounter-diagnosis-example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Condition",
  "id": "encounter-diagnosis-example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"
    ]
  },
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
        "code": "active",
        "display": "Active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-category",
          "code": "encounter-diagnosis",
          "display": "Encounter Diagnosis"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/icd-10-cm",
        "code": "J20.9",
        "display": "Acute bronchitis, unspecified"
      },
      {
        "system": "http://snomed.info/sct",
        "code": "10509002",
        "display": "Acute bronchitis (disorder)"
      }
    ],
    "text": "Acute bronchitis"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "encounter": {
    "reference": "Encounter/example",
    "display": "Office visit"
  },
  "onsetDateTime": "2024-02-08",
  "recordedDate": "2024-02-08T14:15:00-05:00",
  "recorder": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  },
  "asserter": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  }
}

GET Condition - Encounter Diagnosis - Search by Parameter

Searches condition resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=encounter-diagnosis
Parameters
patientreference<example>
clinical-statustoken<active|inactive|resolved>
categorytoken<encounter-diagnosis>
codetoken<ICD-10 / SNOMED code>
Example RequestSearch Encounter Diagnoses
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=encounter-diagnosis"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-75c42e14",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=encounter-diagnosis"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Condition/encounter-diagnosis-example",
      "resource": {
        "resourceType": "Condition",
        "id": "encounter-diagnosis-example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "encounter-diagnosis",
                "display": "Encounter Diagnosis"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/icd-10-cm",
              "code": "J20.9",
              "display": "Acute bronchitis, unspecified"
            },
            {
              "system": "http://snomed.info/sct",
              "code": "10509002",
              "display": "Acute bronchitis (disorder)"
            }
          ],
          "text": "Acute bronchitis"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example",
          "display": "Office visit"
        },
        "onsetDateTime": "2024-02-08",
        "recordedDate": "2024-02-08T14:15:00-05:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "asserter": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Condition - Encounter Diagnosis - Search by Parameter

Searches condition resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Condition/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<encounter-diagnosis>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Condition/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=encounter-diagnosis"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-657bac44",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Condition/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Condition/encounter-diagnosis-example",
      "resource": {
        "resourceType": "Condition",
        "id": "encounter-diagnosis-example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "encounter-diagnosis",
                "display": "Encounter Diagnosis"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/icd-10-cm",
              "code": "J20.9",
              "display": "Acute bronchitis, unspecified"
            },
            {
              "system": "http://snomed.info/sct",
              "code": "10509002",
              "display": "Acute bronchitis (disorder)"
            }
          ],
          "text": "Acute bronchitis"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example",
          "display": "Office visit"
        },
        "onsetDateTime": "2024-02-08",
        "recordedDate": "2024-02-08T14:15:00-05:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "asserter": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Condition (Problems & Health Concerns) Resource Endpoints

Conforms to the US Core Condition Problems and Health Concerns Profile. Returns problem-list items, health concerns (including SDOH), and other longitudinal patient conditions.

GET Condition - Problems & Health Concerns - Read by ID

Retrieves a specific condition record by its logical ID. Requires patient/Condition.read or patient/Condition.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Condition/condition-SDOH-example
Parameters
idstring<condition-SDOH-example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Condition/condition-SDOH-example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Condition",
  "id": "condition-SDOH-example",
  "meta": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/instance-name",
        "valueString": "SDOH Problem/Health Concern Example"
      },
      {
        "url": "http://hl7.org/fhir/StructureDefinition/instance-description",
        "valueMarkdown": "This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient's SDOH Problem/Health Concern."
      }
    ],
    "lastUpdated": "2016-08-10T07:15:07-08:00",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Condition condition-SDOH-example</b></p><a name="condition-SDOH-example"> </a><a name="hccondition-SDOH-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Last updated: 2016-08-10 07:15:07-0800</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-condition-problems-health-concerns.html">US Core Condition Problems and Health Concerns Profile</a></p></div><p><b>Condition Asserted Date</b>: 2016-08-10</p><p><b>clinicalStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-clinical active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-ver-status confirmed}">Confirmed</span></p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-category problem-list-item}">Problem List Item</span>, <span title="Codes:{http://hl7.org/fhir/us/core/CodeSystem/us-core-category sdoh}">Social Determinants Of Health</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 445281000124101}">Nutrition impaired due to limited access to healthful foods (finding)</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>recordedDate</b>: 2016-08-10 07:15:07-0800</p><p><b>recorder</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate",
      "valueDateTime": "2016-08-10"
    }
  ],
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
        "code": "active",
        "display": "Active"
      }
    ],
    "text": "Active"
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ],
    "text": "Confirmed"
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-category",
          "code": "problem-list-item",
          "display": "Problem List Item"
        }
      ],
      "text": "Problem List Item"
    },
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
          "code": "sdoh",
          "display": "SDOH"
        }
      ],
      "text": "Social Determinants Of Health"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "version": "http://snomed.info/sct/731000124108",
        "code": "445281000124101",
        "display": "Nutrition impaired due to limited access to healthful foods (finding)"
      }
    ],
    "text": "Nutrition impaired due to limited access to healthful foods (finding)"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Shaw"
  },
  "recordedDate": "2016-08-10T07:15:07-08:00",
  "recorder": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr Ronald Bone"
  }
}

GET Condition - Problems & Health Concerns - Search by Parameter

Searches condition resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=problem-list-item
Parameters
patientreference<example>
clinical-statustoken<active|inactive|resolved>
categorytoken<problem-list-item|health-concern>
codetoken<SNOMED code>
Example RequestSearch Problem List
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=problem-list-item"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-e79fb3ee",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Condition?patient=example&category=problem-list-item"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Condition/condition-SDOH-example",
      "resource": {
        "resourceType": "Condition",
        "id": "condition-SDOH-example",
        "meta": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/instance-name",
              "valueString": "SDOH Problem/Health Concern Example"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/instance-description",
              "valueMarkdown": "This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient's SDOH Problem/Health Concern."
            }
          ],
          "lastUpdated": "2016-08-10T07:15:07-08:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"
          ]
        },
        "text": {
          "status": "extensions",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Condition condition-SDOH-example</b></p><a name="condition-SDOH-example"> </a><a name="hccondition-SDOH-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Last updated: 2016-08-10 07:15:07-0800</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-condition-problems-health-concerns.html">US Core Condition Problems and Health Concerns Profile</a></p></div><p><b>Condition Asserted Date</b>: 2016-08-10</p><p><b>clinicalStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-clinical active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-ver-status confirmed}">Confirmed</span></p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-category problem-list-item}">Problem List Item</span>, <span title="Codes:{http://hl7.org/fhir/us/core/CodeSystem/us-core-category sdoh}">Social Determinants Of Health</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 445281000124101}">Nutrition impaired due to limited access to healthful foods (finding)</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>recordedDate</b>: 2016-08-10 07:15:07-0800</p><p><b>recorder</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p></div>"
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate",
            "valueDateTime": "2016-08-10"
          }
        ],
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ],
          "text": "Active"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ],
          "text": "Confirmed"
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              }
            ],
            "text": "Problem List Item"
          },
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
                "code": "sdoh",
                "display": "SDOH"
              }
            ],
            "text": "Social Determinants Of Health"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "445281000124101",
              "display": "Nutrition impaired due to limited access to healthful foods (finding)"
            }
          ],
          "text": "Nutrition impaired due to limited access to healthful foods (finding)"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Shaw"
        },
        "recordedDate": "2016-08-10T07:15:07-08:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr Ronald Bone"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Condition - Problems & Health Concerns - Search by Parameter

Searches condition resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Condition/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<health-concern>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Condition/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=health-concern"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5e9e7db8",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Condition/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Condition/condition-SDOH-example",
      "resource": {
        "resourceType": "Condition",
        "id": "condition-SDOH-example",
        "meta": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/instance-name",
              "valueString": "SDOH Problem/Health Concern Example"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/instance-description",
              "valueMarkdown": "This example of a US Core Condition Problems and Health Concerns Profile illustrates its use to capture information about a patient's SDOH Problem/Health Concern."
            }
          ],
          "lastUpdated": "2016-08-10T07:15:07-08:00",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"
          ]
        },
        "text": {
          "status": "extensions",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Condition condition-SDOH-example</b></p><a name="condition-SDOH-example"> </a><a name="hccondition-SDOH-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Last updated: 2016-08-10 07:15:07-0800</p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-condition-problems-health-concerns.html">US Core Condition Problems and Health Concerns Profile</a></p></div><p><b>Condition Asserted Date</b>: 2016-08-10</p><p><b>clinicalStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-clinical active}">Active</span></p><p><b>verificationStatus</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-ver-status confirmed}">Confirmed</span></p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/condition-category problem-list-item}">Problem List Item</span>, <span title="Codes:{http://hl7.org/fhir/us/core/CodeSystem/us-core-category sdoh}">Social Determinants Of Health</span></p><p><b>code</b>: <span title="Codes:{http://snomed.info/sct 445281000124101}">Nutrition impaired due to limited access to healthful foods (finding)</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>recordedDate</b>: 2016-08-10 07:15:07-0800</p><p><b>recorder</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p></div>"
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate",
            "valueDateTime": "2016-08-10"
          }
        ],
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ],
          "text": "Active"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ],
          "text": "Confirmed"
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              }
            ],
            "text": "Problem List Item"
          },
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
                "code": "sdoh",
                "display": "SDOH"
              }
            ],
            "text": "Social Determinants Of Health"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "445281000124101",
              "display": "Nutrition impaired due to limited access to healthful foods (finding)"
            }
          ],
          "text": "Nutrition impaired due to limited access to healthful foods (finding)"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Shaw"
        },
        "recordedDate": "2016-08-10T07:15:07-08:00",
        "recorder": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr Ronald Bone"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Coverage Resource Endpoints

The Coverage API conforms to the US Core Coverage Profile, providing access to a patient’s health insurance coverage.

GET Coverage - Read by ID

Retrieves a specific coverage record by its logical ID. Requires patient/Coverage.read or patient/Coverage.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Coverage/7546D
Parameters
idstring<7546D>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Coverage/7546D
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Coverage",
  "id": "7546D",
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml">A human-readable rendering of the coverage</div>"
  },
  "identifier": [
    {
      "system": "http://xyz.com/codes/identifier",
      "value": "AB98761"
    }
  ],
  "status": "active",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
        "code": "EHCPOL",
        "display": "extended healthcare"
      }
    ]
  },
  "subscriber": {
    "reference": "Patient/5"
  },
  "subscriberId": "AB9876",
  "beneficiary": {
    "reference": "Patient/5"
  },
  "dependent": "1",
  "relationship": {
    "coding": [
      {
        "code": "self"
      }
    ]
  },
  "period": {
    "start": "2011-03-17",
    "end": "2012-03-17"
  },
  "payor": [
    {
      "reference": "Organization/2"
    }
  ],
  "class": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "group"
          }
        ]
      },
      "value": "WESTAIR",
      "name": "Western Airlines"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "plan"
          }
        ]
      },
      "value": "BG4352",
      "name": "Full Coverage: Medical, Dental, Pharmacy, Vision, EHC"
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
            "code": "subplan"
          }
        ]
      },
      "value": "D15C9",
      "name": "Platinum"
    }
  ],
  "order": 2,
  "network": "5",
  "costToBeneficiary": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/coverage-copay-type",
            "code": "gpvisit"
          }
        ]
      },
      "valueMoney": {
        "value": 20,
        "currency": "USD"
      },
      "exception": [
        {
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/ex-coverage-financial-exception",
                "code": "retired"
              }
            ]
          },
          "period": {
            "start": "2018-01-01",
            "end": "2018-12-31"
          }
        }
      ]
    }
  ],
  "contract": [
    {
      "reference": "Contract/INS-101"
    }
  ]
}

GET Coverage - Search by Parameter

Searches coverage resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Coverage?patient=example
Parameters
patientreference<example>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Coverage?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-69cbb7a1",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Coverage?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Coverage/7546D",
      "resource": {
        "resourceType": "Coverage",
        "id": "7546D",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml">A human-readable rendering of the coverage</div>"
        },
        "identifier": [
          {
            "system": "http://xyz.com/codes/identifier",
            "value": "AB98761"
          }
        ],
        "status": "active",
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
              "code": "EHCPOL",
              "display": "extended healthcare"
            }
          ]
        },
        "subscriber": {
          "reference": "Patient/5"
        },
        "subscriberId": "AB9876",
        "beneficiary": {
          "reference": "Patient/5"
        },
        "dependent": "1",
        "relationship": {
          "coding": [
            {
              "code": "self"
            }
          ]
        },
        "period": {
          "start": "2011-03-17",
          "end": "2012-03-17"
        },
        "payor": [
          {
            "reference": "Organization/2"
          }
        ],
        "class": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "group"
                }
              ]
            },
            "value": "WESTAIR",
            "name": "Western Airlines"
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "plan"
                }
              ]
            },
            "value": "BG4352",
            "name": "Full Coverage: Medical, Dental, Pharmacy, Vision, EHC"
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "subplan"
                }
              ]
            },
            "value": "D15C9",
            "name": "Platinum"
          }
        ],
        "order": 2,
        "network": "5",
        "costToBeneficiary": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-copay-type",
                  "code": "gpvisit"
                }
              ]
            },
            "valueMoney": {
              "value": 20,
              "currency": "USD"
            },
            "exception": [
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/ex-coverage-financial-exception",
                      "code": "retired"
                    }
                  ]
                },
                "period": {
                  "start": "2018-01-01",
                  "end": "2018-12-31"
                }
              }
            ]
          }
        ],
        "contract": [
          {
            "reference": "Contract/INS-101"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Coverage - Search by Parameter

Searches coverage resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Coverage/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Coverage/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-ba2bcb1a",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Coverage/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Coverage/7546D",
      "resource": {
        "resourceType": "Coverage",
        "id": "7546D",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml">A human-readable rendering of the coverage</div>"
        },
        "identifier": [
          {
            "system": "http://xyz.com/codes/identifier",
            "value": "AB98761"
          }
        ],
        "status": "active",
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
              "code": "EHCPOL",
              "display": "extended healthcare"
            }
          ]
        },
        "subscriber": {
          "reference": "Patient/5"
        },
        "subscriberId": "AB9876",
        "beneficiary": {
          "reference": "Patient/5"
        },
        "dependent": "1",
        "relationship": {
          "coding": [
            {
              "code": "self"
            }
          ]
        },
        "period": {
          "start": "2011-03-17",
          "end": "2012-03-17"
        },
        "payor": [
          {
            "reference": "Organization/2"
          }
        ],
        "class": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "group"
                }
              ]
            },
            "value": "WESTAIR",
            "name": "Western Airlines"
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "plan"
                }
              ]
            },
            "value": "BG4352",
            "name": "Full Coverage: Medical, Dental, Pharmacy, Vision, EHC"
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "subplan"
                }
              ]
            },
            "value": "D15C9",
            "name": "Platinum"
          }
        ],
        "order": 2,
        "network": "5",
        "costToBeneficiary": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-copay-type",
                  "code": "gpvisit"
                }
              ]
            },
            "valueMoney": {
              "value": 20,
              "currency": "USD"
            },
            "exception": [
              {
                "type": {
                  "coding": [
                    {
                      "system": "http://terminology.hl7.org/CodeSystem/ex-coverage-financial-exception",
                      "code": "retired"
                    }
                  ]
                },
                "period": {
                  "start": "2018-01-01",
                  "end": "2018-12-31"
                }
              }
            ]
          }
        ],
        "contract": [
          {
            "reference": "Contract/INS-101"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Device Resource Endpoints

The Device API conforms to the US Core Implantable Device Profile, returning unique device identifiers (UDI) and metadata.

GET Device - Read by ID

Retrieves a specific device record by its logical ID. Requires patient/Device.read or patient/Device.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Device/udi-1
Parameters
idstring<udi-1>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Device/udi-1
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Device",
  "id": "udi-1",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Device</b><a name="udi-1"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Device &quot;udi-1&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-implantable-device.html">US Core Implantable Device Profile</a></p></div><h3>UdiCarriers</h3><table class="grid"><tr><td>-</td><td><b>DeviceIdentifier</b></td><td><b>CarrierHRF</b></td></tr><tr><td>*</td><td>09504000059118</td><td>(01)09504000059118(17)141120(10)7654321D(21)10987654d321</td></tr></table><p><b>status</b>: active</p><p><b>expirationDate</b>: 2014-11-20</p><p><b>lotNumber</b>: 7654321D</p><p><b>serialNumber</b>: 10987654d321</p><p><b>type</b>: Coated femoral stem prosthesis, modular <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT[US]</a>#468063009)</span></p><p><b>patient</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p></div>"
  },
  "udiCarrier": [
    {
      "deviceIdentifier": "09504000059118",
      "carrierHRF": "(01)09504000059118(17)141120(10)7654321D(21)10987654d321"
    }
  ],
  "status": "active",
  "expirationDate": "2014-11-20",
  "lotNumber": "7654321D",
  "serialNumber": "10987654d321",
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "version": "http://snomed.info/sct/731000124108",
        "code": "468063009",
        "display": "Coated femoral stem prosthesis, modular"
      }
    ]
  },
  "patient": {
    "reference": "Patient/example",
    "display": "Amy Shaw"
  }
}

GET Device - Search by Parameter

Searches device resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Device?patient=example
Parameters
patientreference<example>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Device?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-84184aaf",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Device?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Device/udi-1",
      "resource": {
        "resourceType": "Device",
        "id": "udi-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Device</b><a name="udi-1"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Device &quot;udi-1&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-implantable-device.html">US Core Implantable Device Profile</a></p></div><h3>UdiCarriers</h3><table class="grid"><tr><td>-</td><td><b>DeviceIdentifier</b></td><td><b>CarrierHRF</b></td></tr><tr><td>*</td><td>09504000059118</td><td>(01)09504000059118(17)141120(10)7654321D(21)10987654d321</td></tr></table><p><b>status</b>: active</p><p><b>expirationDate</b>: 2014-11-20</p><p><b>lotNumber</b>: 7654321D</p><p><b>serialNumber</b>: 10987654d321</p><p><b>type</b>: Coated femoral stem prosthesis, modular <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT[US]</a>#468063009)</span></p><p><b>patient</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p></div>"
        },
        "udiCarrier": [
          {
            "deviceIdentifier": "09504000059118",
            "carrierHRF": "(01)09504000059118(17)141120(10)7654321D(21)10987654d321"
          }
        ],
        "status": "active",
        "expirationDate": "2014-11-20",
        "lotNumber": "7654321D",
        "serialNumber": "10987654d321",
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "468063009",
              "display": "Coated femoral stem prosthesis, modular"
            }
          ]
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Device - Search by Parameter

Searches device resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Device/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Device/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-d61af1d0",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Device/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Device/udi-1",
      "resource": {
        "resourceType": "Device",
        "id": "udi-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Device</b><a name="udi-1"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Device &quot;udi-1&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-implantable-device.html">US Core Implantable Device Profile</a></p></div><h3>UdiCarriers</h3><table class="grid"><tr><td>-</td><td><b>DeviceIdentifier</b></td><td><b>CarrierHRF</b></td></tr><tr><td>*</td><td>09504000059118</td><td>(01)09504000059118(17)141120(10)7654321D(21)10987654d321</td></tr></table><p><b>status</b>: active</p><p><b>expirationDate</b>: 2014-11-20</p><p><b>lotNumber</b>: 7654321D</p><p><b>serialNumber</b>: 10987654d321</p><p><b>type</b>: Coated femoral stem prosthesis, modular <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://browser.ihtsdotools.org/">SNOMED CT[US]</a>#468063009)</span></p><p><b>patient</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p></div>"
        },
        "udiCarrier": [
          {
            "deviceIdentifier": "09504000059118",
            "carrierHRF": "(01)09504000059118(17)141120(10)7654321D(21)10987654d321"
          }
        ],
        "status": "active",
        "expirationDate": "2014-11-20",
        "lotNumber": "7654321D",
        "serialNumber": "10987654d321",
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "468063009",
              "display": "Coated femoral stem prosthesis, modular"
            }
          ]
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

DiagnosticReport Resource Endpoints

The DiagnosticReport API conforms to the US Core DiagnosticReport Profile for Laboratory Results and for Report and Note exchange.

GET DiagnosticReport - Read by ID

Retrieves a specific diagnosticreport record by its logical ID. Requires patient/DiagnosticReport.read or patient/DiagnosticReport.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "DiagnosticReport",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
    ]
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
          "code": "LAB",
          "display": "Laboratory"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "58410-2",
        "display": "Complete blood count (hemogram) panel - Blood by Automated count"
      }
    ],
    "text": "CBC w/ Differential"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "effectiveDateTime": "2024-02-08T08:30:00-05:00",
  "issued": "2024-02-08T14:15:00-05:00",
  "performer": [
    {
      "reference": "Organization/acme-lab",
      "display": "Acme Reference Lab"
    }
  ],
  "result": [
    {
      "reference": "Observation/obs-wbc",
      "display": "WBC 6.2 10*3/uL"
    },
    {
      "reference": "Observation/obs-rbc",
      "display": "RBC 4.5 10*6/uL"
    },
    {
      "reference": "Observation/obs-hgb",
      "display": "Hemoglobin 13.8 g/dL"
    }
  ]
}

GET DiagnosticReport - Search by Parameter

Searches diagnosticreport resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport?patient=example&category=LAB
Parameters
patientreference<example>
categorytoken<LAB|RAD|PAT>
codetoken<LOINC code>
datedate<gt2023-01-01>
Example RequestSearch Lab Reports
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport?patient=example&category=LAB"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-4cc9ae3d",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport?patient=example&category=LAB"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/example",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
          ]
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                "code": "LAB",
                "display": "Laboratory"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "58410-2",
              "display": "Complete blood count (hemogram) panel - Blood by Automated count"
            }
          ],
          "text": "CBC w/ Differential"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "effectiveDateTime": "2024-02-08T08:30:00-05:00",
        "issued": "2024-02-08T14:15:00-05:00",
        "performer": [
          {
            "reference": "Organization/acme-lab",
            "display": "Acme Reference Lab"
          }
        ],
        "result": [
          {
            "reference": "Observation/obs-wbc",
            "display": "WBC 6.2 10*3/uL"
          },
          {
            "reference": "Observation/obs-rbc",
            "display": "RBC 4.5 10*6/uL"
          },
          {
            "reference": "Observation/obs-hgb",
            "display": "Hemoglobin 13.8 g/dL"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST DiagnosticReport - Search by Parameter

Searches diagnosticreport resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<LAB>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=LAB"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-48f311a4",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/DiagnosticReport/example",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
          ]
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                "code": "LAB",
                "display": "Laboratory"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "58410-2",
              "display": "Complete blood count (hemogram) panel - Blood by Automated count"
            }
          ],
          "text": "CBC w/ Differential"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "effectiveDateTime": "2024-02-08T08:30:00-05:00",
        "issued": "2024-02-08T14:15:00-05:00",
        "performer": [
          {
            "reference": "Organization/acme-lab",
            "display": "Acme Reference Lab"
          }
        ],
        "result": [
          {
            "reference": "Observation/obs-wbc",
            "display": "WBC 6.2 10*3/uL"
          },
          {
            "reference": "Observation/obs-rbc",
            "display": "RBC 4.5 10*6/uL"
          },
          {
            "reference": "Observation/obs-hgb",
            "display": "Hemoglobin 13.8 g/dL"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

DocumentReference Resource Endpoints

The DocumentReference API conforms to the US Core DocumentReference Profile, supporting clinical notes and document retrieval.

GET DocumentReference - Read by ID

Retrieves a specific documentreference record by its logical ID. Requires patient/DocumentReference.read or patient/DocumentReference.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/DocumentReference/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/DocumentReference/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "DocumentReference",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: current</p><p><b>docStatus</b>: preliminary</p><p><b>type</b>: Outpatient Note <span>(Details : {LOINC code '34108-1' = 'Outpatient Note', given as 'Outpatient Note'})</span></p><p><b>category</b>: History and Physical <span>(Details : {http://ihe.net/xds/connectathon/classCodes code 'History and Physical' = 'History and Physical', given as 'History and Physical'})</span></p><p><b>subject</b>: <a>Patient/xcda</a></p><p><b>date</b>: 24/12/2005 9:43:41 AM</p><p><b>author</b>: </p><ul><li><a>Practitioner/xcda1</a></li><li>id: a2; Gerald Smitty </li></ul><p><b>authenticator</b>: <a>Organization/f001</a></p><p><b>custodian</b>: <a>Organization/f001</a></p><h3>RelatesTos</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>appends</td><td><a>DocumentReference/example</a></td></tr></table><p><b>description</b>: Physical</p><p><b>securityLabel</b>: very restricted <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-Confidentiality code 'V' = 'very restricted', given as 'very restricted'})</span></p><h3>Contents</h3><table><tr><td>-</td><td><b>Attachment</b></td><td><b>Format</b></td></tr><tr><td>*</td><td/><td>History and Physical Specification (Details: urn:oid:1.3.6.1.4.1.19376.1.2.3 code urn:ihe:pcc:handp:2008 = 'urn:ihe:pcc:handp:2008', stated as 'History and Physical Specification')</td></tr></table><h3>Contexts</h3><table><tr><td>-</td><td><b>Encounter</b></td><td><b>Event</b></td><td><b>Period</b></td><td><b>FacilityType</b></td><td><b>PracticeSetting</b></td><td><b>SourcePatientInfo</b></td><td><b>Related</b></td></tr><tr><td>*</td><td><a>Encounter/xcda</a></td><td>Arm <span>(Details : {http://ihe.net/xds/connectathon/eventCodes code 'T-D8200' = 'T-D8200', given as 'Arm'})</span></td><td>23/12/2004 8:00:00 AM --&gt; 23/12/2004 8:01:00 AM</td><td>Outpatient <span>(Details : {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes code 'Outpatient' = 'Outpatient', given as 'Outpatient'})</span></td><td>General Medicine <span>(Details : {http://www.ihe.net/xds/connectathon/practiceSettingCodes code 'General Medicine' = 'General Medicine', given as 'General Medicine'})</span></td><td><a>Patient/xcda</a></td><td><a>Patient/xcda</a></td></tr></table></div>"
  },
  "contained": [
    {
      "resourceType": "Practitioner",
      "id": "a2",
      "name": [
        {
          "family": "Smitty",
          "given": [
            "Gerald"
          ]
        }
      ]
    }
  ],
  "masterIdentifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
  },
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
    }
  ],
  "status": "current",
  "docStatus": "preliminary",
  "type": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "34108-1",
        "display": "Outpatient Note"
      }
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://ihe.net/xds/connectathon/classCodes",
          "code": "History and Physical",
          "display": "History and Physical"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/xcda"
  },
  "date": "2005-12-24T09:43:41+11:00",
  "author": [
    {
      "reference": "Practitioner/xcda1"
    },
    {
      "reference": "#a2"
    }
  ],
  "authenticator": {
    "reference": "Organization/f001"
  },
  "custodian": {
    "reference": "Organization/f001"
  },
  "relatesTo": [
    {
      "code": "appends",
      "target": {
        "reference": "DocumentReference/example"
      }
    }
  ],
  "description": "Physical",
  "securityLabel": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
          "code": "V",
          "display": "very restricted"
        }
      ]
    }
  ],
  "content": [
    {
      "attachment": {
        "contentType": "application/hl7-v3+xml",
        "language": "en-US",
        "url": "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510",
        "size": 3654,
        "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
        "title": "Physical",
        "creation": "2005-12-24T09:35:00+11:00"
      },
      "format": {
        "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
        "code": "urn:ihe:pcc:handp:2008",
        "display": "History and Physical Specification"
      }
    }
  ],
  "context": {
    "encounter": [
      {
        "reference": "Encounter/xcda"
      }
    ],
    "event": [
      {
        "coding": [
          {
            "system": "http://ihe.net/xds/connectathon/eventCodes",
            "code": "T-D8200",
            "display": "Arm"
          }
        ]
      }
    ],
    "period": {
      "start": "2004-12-23T08:00:00+11:00",
      "end": "2004-12-23T08:01:00+11:00"
    },
    "facilityType": {
      "coding": [
        {
          "system": "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes",
          "code": "Outpatient",
          "display": "Outpatient"
        }
      ]
    },
    "practiceSetting": {
      "coding": [
        {
          "system": "http://www.ihe.net/xds/connectathon/practiceSettingCodes",
          "code": "General Medicine",
          "display": "General Medicine"
        }
      ]
    },
    "sourcePatientInfo": {
      "reference": "Patient/xcda"
    },
    "related": [
      {
        "reference": "Patient/xcda",
        "identifier": {
          "system": "urn:ietf:rfc:3986",
          "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345"
        }
      }
    ]
  }
}

GET DocumentReference - Search by Parameter

Searches documentreference resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/DocumentReference?patient=example&category=clinical-note
Parameters
patientreference<example>
categorytoken<clinical-note>
typetoken<LOINC code>
datedate<gt2023-01-01>
Example RequestSearch Clinical Notes
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference?patient=example&category=clinical-note"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-a148854a",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference?patient=example&category=clinical-note"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference/example",
      "resource": {
        "resourceType": "DocumentReference",
        "id": "example",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: current</p><p><b>docStatus</b>: preliminary</p><p><b>type</b>: Outpatient Note <span>(Details : {LOINC code '34108-1' = 'Outpatient Note', given as 'Outpatient Note'})</span></p><p><b>category</b>: History and Physical <span>(Details : {http://ihe.net/xds/connectathon/classCodes code 'History and Physical' = 'History and Physical', given as 'History and Physical'})</span></p><p><b>subject</b>: <a>Patient/xcda</a></p><p><b>date</b>: 24/12/2005 9:43:41 AM</p><p><b>author</b>: </p><ul><li><a>Practitioner/xcda1</a></li><li>id: a2; Gerald Smitty </li></ul><p><b>authenticator</b>: <a>Organization/f001</a></p><p><b>custodian</b>: <a>Organization/f001</a></p><h3>RelatesTos</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>appends</td><td><a>DocumentReference/example</a></td></tr></table><p><b>description</b>: Physical</p><p><b>securityLabel</b>: very restricted <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-Confidentiality code 'V' = 'very restricted', given as 'very restricted'})</span></p><h3>Contents</h3><table><tr><td>-</td><td><b>Attachment</b></td><td><b>Format</b></td></tr><tr><td>*</td><td/><td>History and Physical Specification (Details: urn:oid:1.3.6.1.4.1.19376.1.2.3 code urn:ihe:pcc:handp:2008 = 'urn:ihe:pcc:handp:2008', stated as 'History and Physical Specification')</td></tr></table><h3>Contexts</h3><table><tr><td>-</td><td><b>Encounter</b></td><td><b>Event</b></td><td><b>Period</b></td><td><b>FacilityType</b></td><td><b>PracticeSetting</b></td><td><b>SourcePatientInfo</b></td><td><b>Related</b></td></tr><tr><td>*</td><td><a>Encounter/xcda</a></td><td>Arm <span>(Details : {http://ihe.net/xds/connectathon/eventCodes code 'T-D8200' = 'T-D8200', given as 'Arm'})</span></td><td>23/12/2004 8:00:00 AM --&gt; 23/12/2004 8:01:00 AM</td><td>Outpatient <span>(Details : {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes code 'Outpatient' = 'Outpatient', given as 'Outpatient'})</span></td><td>General Medicine <span>(Details : {http://www.ihe.net/xds/connectathon/practiceSettingCodes code 'General Medicine' = 'General Medicine', given as 'General Medicine'})</span></td><td><a>Patient/xcda</a></td><td><a>Patient/xcda</a></td></tr></table></div>"
        },
        "contained": [
          {
            "resourceType": "Practitioner",
            "id": "a2",
            "name": [
              {
                "family": "Smitty",
                "given": [
                  "Gerald"
                ]
              }
            ]
          }
        ],
        "masterIdentifier": {
          "system": "urn:ietf:rfc:3986",
          "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
        },
        "identifier": [
          {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
          }
        ],
        "status": "current",
        "docStatus": "preliminary",
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "34108-1",
              "display": "Outpatient Note"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://ihe.net/xds/connectathon/classCodes",
                "code": "History and Physical",
                "display": "History and Physical"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/xcda"
        },
        "date": "2005-12-24T09:43:41+11:00",
        "author": [
          {
            "reference": "Practitioner/xcda1"
          },
          {
            "reference": "#a2"
          }
        ],
        "authenticator": {
          "reference": "Organization/f001"
        },
        "custodian": {
          "reference": "Organization/f001"
        },
        "relatesTo": [
          {
            "code": "appends",
            "target": {
              "reference": "DocumentReference/example"
            }
          }
        ],
        "description": "Physical",
        "securityLabel": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                "code": "V",
                "display": "very restricted"
              }
            ]
          }
        ],
        "content": [
          {
            "attachment": {
              "contentType": "application/hl7-v3+xml",
              "language": "en-US",
              "url": "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510",
              "size": 3654,
              "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
              "title": "Physical",
              "creation": "2005-12-24T09:35:00+11:00"
            },
            "format": {
              "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
              "code": "urn:ihe:pcc:handp:2008",
              "display": "History and Physical Specification"
            }
          }
        ],
        "context": {
          "encounter": [
            {
              "reference": "Encounter/xcda"
            }
          ],
          "event": [
            {
              "coding": [
                {
                  "system": "http://ihe.net/xds/connectathon/eventCodes",
                  "code": "T-D8200",
                  "display": "Arm"
                }
              ]
            }
          ],
          "period": {
            "start": "2004-12-23T08:00:00+11:00",
            "end": "2004-12-23T08:01:00+11:00"
          },
          "facilityType": {
            "coding": [
              {
                "system": "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes",
                "code": "Outpatient",
                "display": "Outpatient"
              }
            ]
          },
          "practiceSetting": {
            "coding": [
              {
                "system": "http://www.ihe.net/xds/connectathon/practiceSettingCodes",
                "code": "General Medicine",
                "display": "General Medicine"
              }
            ]
          },
          "sourcePatientInfo": {
            "reference": "Patient/xcda"
          },
          "related": [
            {
              "reference": "Patient/xcda",
              "identifier": {
                "system": "urn:ietf:rfc:3986",
                "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345"
              }
            }
          ]
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST DocumentReference - Search by Parameter

Searches documentreference resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/DocumentReference/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<clinical-note>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=clinical-note"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-27ea0d9c",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/DocumentReference/example",
      "resource": {
        "resourceType": "DocumentReference",
        "id": "example",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>masterIdentifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: current</p><p><b>docStatus</b>: preliminary</p><p><b>type</b>: Outpatient Note <span>(Details : {LOINC code '34108-1' = 'Outpatient Note', given as 'Outpatient Note'})</span></p><p><b>category</b>: History and Physical <span>(Details : {http://ihe.net/xds/connectathon/classCodes code 'History and Physical' = 'History and Physical', given as 'History and Physical'})</span></p><p><b>subject</b>: <a>Patient/xcda</a></p><p><b>date</b>: 24/12/2005 9:43:41 AM</p><p><b>author</b>: </p><ul><li><a>Practitioner/xcda1</a></li><li>id: a2; Gerald Smitty </li></ul><p><b>authenticator</b>: <a>Organization/f001</a></p><p><b>custodian</b>: <a>Organization/f001</a></p><h3>RelatesTos</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Target</b></td></tr><tr><td>*</td><td>appends</td><td><a>DocumentReference/example</a></td></tr></table><p><b>description</b>: Physical</p><p><b>securityLabel</b>: very restricted <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-Confidentiality code 'V' = 'very restricted', given as 'very restricted'})</span></p><h3>Contents</h3><table><tr><td>-</td><td><b>Attachment</b></td><td><b>Format</b></td></tr><tr><td>*</td><td/><td>History and Physical Specification (Details: urn:oid:1.3.6.1.4.1.19376.1.2.3 code urn:ihe:pcc:handp:2008 = 'urn:ihe:pcc:handp:2008', stated as 'History and Physical Specification')</td></tr></table><h3>Contexts</h3><table><tr><td>-</td><td><b>Encounter</b></td><td><b>Event</b></td><td><b>Period</b></td><td><b>FacilityType</b></td><td><b>PracticeSetting</b></td><td><b>SourcePatientInfo</b></td><td><b>Related</b></td></tr><tr><td>*</td><td><a>Encounter/xcda</a></td><td>Arm <span>(Details : {http://ihe.net/xds/connectathon/eventCodes code 'T-D8200' = 'T-D8200', given as 'Arm'})</span></td><td>23/12/2004 8:00:00 AM --&gt; 23/12/2004 8:01:00 AM</td><td>Outpatient <span>(Details : {http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes code 'Outpatient' = 'Outpatient', given as 'Outpatient'})</span></td><td>General Medicine <span>(Details : {http://www.ihe.net/xds/connectathon/practiceSettingCodes code 'General Medicine' = 'General Medicine', given as 'General Medicine'})</span></td><td><a>Patient/xcda</a></td><td><a>Patient/xcda</a></td></tr></table></div>"
        },
        "contained": [
          {
            "resourceType": "Practitioner",
            "id": "a2",
            "name": [
              {
                "family": "Smitty",
                "given": [
                  "Gerald"
                ]
              }
            ]
          }
        ],
        "masterIdentifier": {
          "system": "urn:ietf:rfc:3986",
          "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
        },
        "identifier": [
          {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
          }
        ],
        "status": "current",
        "docStatus": "preliminary",
        "type": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "34108-1",
              "display": "Outpatient Note"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://ihe.net/xds/connectathon/classCodes",
                "code": "History and Physical",
                "display": "History and Physical"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/xcda"
        },
        "date": "2005-12-24T09:43:41+11:00",
        "author": [
          {
            "reference": "Practitioner/xcda1"
          },
          {
            "reference": "#a2"
          }
        ],
        "authenticator": {
          "reference": "Organization/f001"
        },
        "custodian": {
          "reference": "Organization/f001"
        },
        "relatesTo": [
          {
            "code": "appends",
            "target": {
              "reference": "DocumentReference/example"
            }
          }
        ],
        "description": "Physical",
        "securityLabel": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
                "code": "V",
                "display": "very restricted"
              }
            ]
          }
        ],
        "content": [
          {
            "attachment": {
              "contentType": "application/hl7-v3+xml",
              "language": "en-US",
              "url": "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510",
              "size": 3654,
              "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
              "title": "Physical",
              "creation": "2005-12-24T09:35:00+11:00"
            },
            "format": {
              "system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
              "code": "urn:ihe:pcc:handp:2008",
              "display": "History and Physical Specification"
            }
          }
        ],
        "context": {
          "encounter": [
            {
              "reference": "Encounter/xcda"
            }
          ],
          "event": [
            {
              "coding": [
                {
                  "system": "http://ihe.net/xds/connectathon/eventCodes",
                  "code": "T-D8200",
                  "display": "Arm"
                }
              ]
            }
          ],
          "period": {
            "start": "2004-12-23T08:00:00+11:00",
            "end": "2004-12-23T08:01:00+11:00"
          },
          "facilityType": {
            "coding": [
              {
                "system": "http://www.ihe.net/xds/connectathon/healthcareFacilityTypeCodes",
                "code": "Outpatient",
                "display": "Outpatient"
              }
            ]
          },
          "practiceSetting": {
            "coding": [
              {
                "system": "http://www.ihe.net/xds/connectathon/practiceSettingCodes",
                "code": "General Medicine",
                "display": "General Medicine"
              }
            ]
          },
          "sourcePatientInfo": {
            "reference": "Patient/xcda"
          },
          "related": [
            {
              "reference": "Patient/xcda",
              "identifier": {
                "system": "urn:ietf:rfc:3986",
                "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.2345"
              }
            }
          ]
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Encounter Resource Endpoints

The Encounter API conforms to the US Core Encounter Profile, representing visits and interactions between patients and providers.

GET Encounter - Read by ID

Retrieves a specific encounter record by its logical ID. Requires patient/Encounter.read or patient/Encounter.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Encounter/f203
Parameters
idstring<f203>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Encounter/f203
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Encounter",
  "id": "f203",
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: f203</p><p><b>identifier</b>: Encounter_Roel_20130311 (TEMP)</p><p><b>status</b>: finished</p><h3>StatusHistories</h3><table><tr><td>-</td><td><b>Status</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>arrived</td><td>08/03/2013 --&gt; (ongoing)</td></tr></table><p><b>class</b>: inpatient encounter (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code IMP = 'inpatient encounter', stated as 'inpatient encounter')</p><p><b>type</b>: Inpatient stay for nine days <span>(Details : {SNOMED CT code '183807002' = 'Inpatient stay 9 days', given as 'Inpatient stay for nine days'})</span></p><p><b>priority</b>: High priority <span>(Details : {SNOMED CT code '394849002' = 'High priority', given as 'High priority'})</span></p><p><b>subject</b>: <a>Roel</a></p><p><b>episodeOfCare</b>: <a>EpisodeOfCare/example</a></p><p><b>basedOn</b>: <a>ServiceRequest/myringotomy</a></p><h3>Participants</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Individual</b></td></tr><tr><td>*</td><td>Participation <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ParticipationType code 'PART' = 'Participation)</span></td><td><a>Practitioner/f201</a></td></tr></table><p><b>appointment</b>: <a>Appointment/example</a></p><p><b>period</b>: 11/03/2013 --&gt; 20/03/2013</p><p><b>reasonCode</b>: The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy. <span>(Details )</span></p><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/stroke</a></p><p><b>use</b>: Admission diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'AD' = 'Admission diagnosis', given as 'Admission diagnosis'})</span></p><p><b>rank</b>: 1</p></blockquote><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/f201</a></p><p><b>use</b>: Discharge diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'DD' = 'Discharge diagnosis', given as 'Discharge diagnosis'})</span></p></blockquote><p><b>account</b>: <a>Account/example</a></p><h3>Hospitalizations</h3><table><tr><td>-</td><td><b>Origin</b></td><td><b>AdmitSource</b></td><td><b>ReAdmission</b></td><td><b>DietPreference</b></td><td><b>SpecialCourtesy</b></td><td><b>SpecialArrangement</b></td><td><b>Destination</b></td></tr><tr><td>*</td><td><a>Location/2</a></td><td>Clinical Oncology Department <span>(Details : {SNOMED CT code '309902002' = 'Clinical oncology department', given as 'Clinical Oncology Department'})</span></td><td>readmitted <span>(Details : {[not stated] code 'null' = 'null', given as 'readmitted'})</span></td><td>Fluid balance regulation <span>(Details : {SNOMED CT code '276026009' = 'Fluid balance regulation', given as 'Fluid balance regulation'})</span></td><td>normal courtesy <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy code 'NRM' = 'normal courtesy', given as 'normal courtesy'})</span></td><td>Wheelchair <span>(Details : {http://terminology.hl7.org/CodeSystem/encounter-special-arrangements code 'wheel' = 'Wheelchair', given as 'Wheelchair'})</span></td><td><a>Location/2</a></td></tr></table><p><b>serviceProvider</b>: <a>Organization/2</a></p><p><b>partOf</b>: <a>Encounter/f203</a></p></div>"
  },
  "identifier": [
    {
      "use": "temp",
      "value": "Encounter_Roel_20130311"
    }
  ],
  "status": "finished",
  "statusHistory": [
    {
      "status": "arrived",
      "period": {
        "start": "2013-03-08"
      }
    }
  ],
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "IMP",
    "display": "inpatient encounter"
  },
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "183807002",
          "display": "Inpatient stay for nine days"
        }
      ]
    }
  ],
  "priority": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "394849002",
        "display": "High priority"
      }
    ]
  },
  "subject": {
    "reference": "Patient/f201",
    "display": "Roel"
  },
  "episodeOfCare": [
    {
      "reference": "EpisodeOfCare/example"
    }
  ],
  "basedOn": [
    {
      "reference": "ServiceRequest/myringotomy"
    }
  ],
  "participant": [
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PART"
            }
          ]
        }
      ],
      "individual": {
        "reference": "Practitioner/f201"
      }
    }
  ],
  "appointment": [
    {
      "reference": "Appointment/example"
    }
  ],
  "period": {
    "start": "2013-03-11",
    "end": "2013-03-20"
  },
  "reasonCode": [
    {
      "text": "The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy."
    }
  ],
  "diagnosis": [
    {
      "condition": {
        "reference": "Condition/stroke"
      },
      "use": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
            "code": "AD",
            "display": "Admission diagnosis"
          }
        ]
      },
      "rank": 1
    },
    {
      "condition": {
        "reference": "Condition/f201"
      },
      "use": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
            "code": "DD",
            "display": "Discharge diagnosis"
          }
        ]
      }
    }
  ],
  "account": [
    {
      "reference": "Account/example"
    }
  ],
  "hospitalization": {
    "origin": {
      "reference": "Location/2"
    },
    "admitSource": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "309902002",
          "display": "Clinical Oncology Department"
        }
      ]
    },
    "reAdmission": {
      "coding": [
        {
          "display": "readmitted"
        }
      ]
    },
    "dietPreference": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "276026009",
            "display": "Fluid balance regulation"
          }
        ]
      }
    ],
    "specialCourtesy": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy",
            "code": "NRM",
            "display": "normal courtesy"
          }
        ]
      }
    ],
    "specialArrangement": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/encounter-special-arrangements",
            "code": "wheel",
            "display": "Wheelchair"
          }
        ]
      }
    ],
    "destination": {
      "reference": "Location/2"
    }
  },
  "serviceProvider": {
    "reference": "Organization/2"
  },
  "partOf": {
    "reference": "Encounter/f203"
  }
}

GET Encounter - Search by Parameter

Searches encounter resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Encounter?patient=example&date=gt2023-01-01
Parameters
patientreference<example>
datedate<gt2023-01-01>
Example RequestSearch by Date
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Encounter?patient=example&date=gt2023-01-01"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-eee3bcd0",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Encounter?patient=example&date=gt2023-01-01"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Encounter/f203",
      "resource": {
        "resourceType": "Encounter",
        "id": "f203",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: f203</p><p><b>identifier</b>: Encounter_Roel_20130311 (TEMP)</p><p><b>status</b>: finished</p><h3>StatusHistories</h3><table><tr><td>-</td><td><b>Status</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>arrived</td><td>08/03/2013 --&gt; (ongoing)</td></tr></table><p><b>class</b>: inpatient encounter (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code IMP = 'inpatient encounter', stated as 'inpatient encounter')</p><p><b>type</b>: Inpatient stay for nine days <span>(Details : {SNOMED CT code '183807002' = 'Inpatient stay 9 days', given as 'Inpatient stay for nine days'})</span></p><p><b>priority</b>: High priority <span>(Details : {SNOMED CT code '394849002' = 'High priority', given as 'High priority'})</span></p><p><b>subject</b>: <a>Roel</a></p><p><b>episodeOfCare</b>: <a>EpisodeOfCare/example</a></p><p><b>basedOn</b>: <a>ServiceRequest/myringotomy</a></p><h3>Participants</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Individual</b></td></tr><tr><td>*</td><td>Participation <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ParticipationType code 'PART' = 'Participation)</span></td><td><a>Practitioner/f201</a></td></tr></table><p><b>appointment</b>: <a>Appointment/example</a></p><p><b>period</b>: 11/03/2013 --&gt; 20/03/2013</p><p><b>reasonCode</b>: The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy. <span>(Details )</span></p><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/stroke</a></p><p><b>use</b>: Admission diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'AD' = 'Admission diagnosis', given as 'Admission diagnosis'})</span></p><p><b>rank</b>: 1</p></blockquote><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/f201</a></p><p><b>use</b>: Discharge diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'DD' = 'Discharge diagnosis', given as 'Discharge diagnosis'})</span></p></blockquote><p><b>account</b>: <a>Account/example</a></p><h3>Hospitalizations</h3><table><tr><td>-</td><td><b>Origin</b></td><td><b>AdmitSource</b></td><td><b>ReAdmission</b></td><td><b>DietPreference</b></td><td><b>SpecialCourtesy</b></td><td><b>SpecialArrangement</b></td><td><b>Destination</b></td></tr><tr><td>*</td><td><a>Location/2</a></td><td>Clinical Oncology Department <span>(Details : {SNOMED CT code '309902002' = 'Clinical oncology department', given as 'Clinical Oncology Department'})</span></td><td>readmitted <span>(Details : {[not stated] code 'null' = 'null', given as 'readmitted'})</span></td><td>Fluid balance regulation <span>(Details : {SNOMED CT code '276026009' = 'Fluid balance regulation', given as 'Fluid balance regulation'})</span></td><td>normal courtesy <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy code 'NRM' = 'normal courtesy', given as 'normal courtesy'})</span></td><td>Wheelchair <span>(Details : {http://terminology.hl7.org/CodeSystem/encounter-special-arrangements code 'wheel' = 'Wheelchair', given as 'Wheelchair'})</span></td><td><a>Location/2</a></td></tr></table><p><b>serviceProvider</b>: <a>Organization/2</a></p><p><b>partOf</b>: <a>Encounter/f203</a></p></div>"
        },
        "identifier": [
          {
            "use": "temp",
            "value": "Encounter_Roel_20130311"
          }
        ],
        "status": "finished",
        "statusHistory": [
          {
            "status": "arrived",
            "period": {
              "start": "2013-03-08"
            }
          }
        ],
        "class": {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "IMP",
          "display": "inpatient encounter"
        },
        "type": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "183807002",
                "display": "Inpatient stay for nine days"
              }
            ]
          }
        ],
        "priority": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394849002",
              "display": "High priority"
            }
          ]
        },
        "subject": {
          "reference": "Patient/f201",
          "display": "Roel"
        },
        "episodeOfCare": [
          {
            "reference": "EpisodeOfCare/example"
          }
        ],
        "basedOn": [
          {
            "reference": "ServiceRequest/myringotomy"
          }
        ],
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "PART"
                  }
                ]
              }
            ],
            "individual": {
              "reference": "Practitioner/f201"
            }
          }
        ],
        "appointment": [
          {
            "reference": "Appointment/example"
          }
        ],
        "period": {
          "start": "2013-03-11",
          "end": "2013-03-20"
        },
        "reasonCode": [
          {
            "text": "The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy."
          }
        ],
        "diagnosis": [
          {
            "condition": {
              "reference": "Condition/stroke"
            },
            "use": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
                  "code": "AD",
                  "display": "Admission diagnosis"
                }
              ]
            },
            "rank": 1
          },
          {
            "condition": {
              "reference": "Condition/f201"
            },
            "use": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
                  "code": "DD",
                  "display": "Discharge diagnosis"
                }
              ]
            }
          }
        ],
        "account": [
          {
            "reference": "Account/example"
          }
        ],
        "hospitalization": {
          "origin": {
            "reference": "Location/2"
          },
          "admitSource": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "309902002",
                "display": "Clinical Oncology Department"
              }
            ]
          },
          "reAdmission": {
            "coding": [
              {
                "display": "readmitted"
              }
            ]
          },
          "dietPreference": [
            {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "276026009",
                  "display": "Fluid balance regulation"
                }
              ]
            }
          ],
          "specialCourtesy": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy",
                  "code": "NRM",
                  "display": "normal courtesy"
                }
              ]
            }
          ],
          "specialArrangement": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/encounter-special-arrangements",
                  "code": "wheel",
                  "display": "Wheelchair"
                }
              ]
            }
          ],
          "destination": {
            "reference": "Location/2"
          }
        },
        "serviceProvider": {
          "reference": "Organization/2"
        },
        "partOf": {
          "reference": "Encounter/f203"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Encounter - Search by Parameter

Searches encounter resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Encounter/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
datedate<gt2023-01-01>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Encounter/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "date=gt2023-01-01"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-ff23c46c",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Encounter/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Encounter/f203",
      "resource": {
        "resourceType": "Encounter",
        "id": "f203",
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: f203</p><p><b>identifier</b>: Encounter_Roel_20130311 (TEMP)</p><p><b>status</b>: finished</p><h3>StatusHistories</h3><table><tr><td>-</td><td><b>Status</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>arrived</td><td>08/03/2013 --&gt; (ongoing)</td></tr></table><p><b>class</b>: inpatient encounter (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code IMP = 'inpatient encounter', stated as 'inpatient encounter')</p><p><b>type</b>: Inpatient stay for nine days <span>(Details : {SNOMED CT code '183807002' = 'Inpatient stay 9 days', given as 'Inpatient stay for nine days'})</span></p><p><b>priority</b>: High priority <span>(Details : {SNOMED CT code '394849002' = 'High priority', given as 'High priority'})</span></p><p><b>subject</b>: <a>Roel</a></p><p><b>episodeOfCare</b>: <a>EpisodeOfCare/example</a></p><p><b>basedOn</b>: <a>ServiceRequest/myringotomy</a></p><h3>Participants</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Individual</b></td></tr><tr><td>*</td><td>Participation <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ParticipationType code 'PART' = 'Participation)</span></td><td><a>Practitioner/f201</a></td></tr></table><p><b>appointment</b>: <a>Appointment/example</a></p><p><b>period</b>: 11/03/2013 --&gt; 20/03/2013</p><p><b>reasonCode</b>: The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy. <span>(Details )</span></p><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/stroke</a></p><p><b>use</b>: Admission diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'AD' = 'Admission diagnosis', given as 'Admission diagnosis'})</span></p><p><b>rank</b>: 1</p></blockquote><blockquote><p><b>diagnosis</b></p><p><b>condition</b>: <a>Condition/f201</a></p><p><b>use</b>: Discharge diagnosis <span>(Details : {http://terminology.hl7.org/CodeSystem/diagnosis-role code 'DD' = 'Discharge diagnosis', given as 'Discharge diagnosis'})</span></p></blockquote><p><b>account</b>: <a>Account/example</a></p><h3>Hospitalizations</h3><table><tr><td>-</td><td><b>Origin</b></td><td><b>AdmitSource</b></td><td><b>ReAdmission</b></td><td><b>DietPreference</b></td><td><b>SpecialCourtesy</b></td><td><b>SpecialArrangement</b></td><td><b>Destination</b></td></tr><tr><td>*</td><td><a>Location/2</a></td><td>Clinical Oncology Department <span>(Details : {SNOMED CT code '309902002' = 'Clinical oncology department', given as 'Clinical Oncology Department'})</span></td><td>readmitted <span>(Details : {[not stated] code 'null' = 'null', given as 'readmitted'})</span></td><td>Fluid balance regulation <span>(Details : {SNOMED CT code '276026009' = 'Fluid balance regulation', given as 'Fluid balance regulation'})</span></td><td>normal courtesy <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy code 'NRM' = 'normal courtesy', given as 'normal courtesy'})</span></td><td>Wheelchair <span>(Details : {http://terminology.hl7.org/CodeSystem/encounter-special-arrangements code 'wheel' = 'Wheelchair', given as 'Wheelchair'})</span></td><td><a>Location/2</a></td></tr></table><p><b>serviceProvider</b>: <a>Organization/2</a></p><p><b>partOf</b>: <a>Encounter/f203</a></p></div>"
        },
        "identifier": [
          {
            "use": "temp",
            "value": "Encounter_Roel_20130311"
          }
        ],
        "status": "finished",
        "statusHistory": [
          {
            "status": "arrived",
            "period": {
              "start": "2013-03-08"
            }
          }
        ],
        "class": {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "IMP",
          "display": "inpatient encounter"
        },
        "type": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "183807002",
                "display": "Inpatient stay for nine days"
              }
            ]
          }
        ],
        "priority": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "394849002",
              "display": "High priority"
            }
          ]
        },
        "subject": {
          "reference": "Patient/f201",
          "display": "Roel"
        },
        "episodeOfCare": [
          {
            "reference": "EpisodeOfCare/example"
          }
        ],
        "basedOn": [
          {
            "reference": "ServiceRequest/myringotomy"
          }
        ],
        "participant": [
          {
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "PART"
                  }
                ]
              }
            ],
            "individual": {
              "reference": "Practitioner/f201"
            }
          }
        ],
        "appointment": [
          {
            "reference": "Appointment/example"
          }
        ],
        "period": {
          "start": "2013-03-11",
          "end": "2013-03-20"
        },
        "reasonCode": [
          {
            "text": "The patient seems to suffer from bilateral pneumonia and renal insufficiency, most likely due to chemotherapy."
          }
        ],
        "diagnosis": [
          {
            "condition": {
              "reference": "Condition/stroke"
            },
            "use": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
                  "code": "AD",
                  "display": "Admission diagnosis"
                }
              ]
            },
            "rank": 1
          },
          {
            "condition": {
              "reference": "Condition/f201"
            },
            "use": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/diagnosis-role",
                  "code": "DD",
                  "display": "Discharge diagnosis"
                }
              ]
            }
          }
        ],
        "account": [
          {
            "reference": "Account/example"
          }
        ],
        "hospitalization": {
          "origin": {
            "reference": "Location/2"
          },
          "admitSource": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "309902002",
                "display": "Clinical Oncology Department"
              }
            ]
          },
          "reAdmission": {
            "coding": [
              {
                "display": "readmitted"
              }
            ]
          },
          "dietPreference": [
            {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "276026009",
                  "display": "Fluid balance regulation"
                }
              ]
            }
          ],
          "specialCourtesy": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-EncounterSpecialCourtesy",
                  "code": "NRM",
                  "display": "normal courtesy"
                }
              ]
            }
          ],
          "specialArrangement": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/encounter-special-arrangements",
                  "code": "wheel",
                  "display": "Wheelchair"
                }
              ]
            }
          ],
          "destination": {
            "reference": "Location/2"
          }
        },
        "serviceProvider": {
          "reference": "Organization/2"
        },
        "partOf": {
          "reference": "Encounter/f203"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Goal Resource Endpoints

The Goal API conforms to the US Core Goal Profile, capturing patient-stated and clinician-stated care goals.

GET Goal - Read by ID

Retrieves a specific goal record by its logical ID. Requires patient/Goal.read or patient/Goal.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Goal/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Goal/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Goal",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
    ]
  },
  "lifecycleStatus": "active",
  "achievementStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
        "code": "in-progress",
        "display": "In Progress"
      }
    ]
  },
  "description": {
    "text": "Reduce HbA1c to below 7.0% within 6 months"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "startDate": "2024-01-15",
  "target": [
    {
      "measure": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "4548-4",
            "display": "Hemoglobin A1c/Hemoglobin.total in Blood"
          }
        ]
      },
      "detailQuantity": {
        "value": 7,
        "unit": "%",
        "system": "http://unitsofmeasure.org",
        "code": "%"
      },
      "dueDate": "2024-07-15"
    }
  ],
  "expressedBy": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  }
}

GET Goal - Search by Parameter

Searches goal resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Goal?lifecycle-status=active
Parameters
lifecycle-statustoken<active|completed|cancelled>
Example RequestSearch Active Goals
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Goal?lifecycle-status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-62e936e6",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Goal?lifecycle-status=active"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Goal/example",
      "resource": {
        "resourceType": "Goal",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
          ]
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
              "code": "in-progress",
              "display": "In Progress"
            }
          ]
        },
        "description": {
          "text": "Reduce HbA1c to below 7.0% within 6 months"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "startDate": "2024-01-15",
        "target": [
          {
            "measure": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "4548-4",
                  "display": "Hemoglobin A1c/Hemoglobin.total in Blood"
                }
              ]
            },
            "detailQuantity": {
              "value": 7,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            },
            "dueDate": "2024-07-15"
          }
        ],
        "expressedBy": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Goal - Search by Parameter

Searches goal resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Goal/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
lifecycle-statustoken<active|completed|cancelled>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Goal/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "lifecycle-status=active|completed|cancelled"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b92c1049",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Goal/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Goal/example",
      "resource": {
        "resourceType": "Goal",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
          ]
        },
        "lifecycleStatus": "active",
        "achievementStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/goal-achievement",
              "code": "in-progress",
              "display": "In Progress"
            }
          ]
        },
        "description": {
          "text": "Reduce HbA1c to below 7.0% within 6 months"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "startDate": "2024-01-15",
        "target": [
          {
            "measure": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "4548-4",
                  "display": "Hemoglobin A1c/Hemoglobin.total in Blood"
                }
              ]
            },
            "detailQuantity": {
              "value": 7,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            },
            "dueDate": "2024-07-15"
          }
        ],
        "expressedBy": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Group Resource Endpoints

The Group API supports SMART Bulk Data Access, returning cohort definitions used by $export operations.

GET Group - Read by ID

Retrieves a specific group record by its logical ID. Requires patient/Group.read or patient/Group.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Group/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Group/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Group",
  "id": "example",
  "type": "person",
  "actual": true,
  "name": "Type 2 Diabetes Cohort",
  "quantity": 152,
  "managingEntity": {
    "reference": "Organization/nexapoint-health",
    "display": "NexaPoint Health"
  },
  "characteristic": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "44054006",
            "display": "Diabetes mellitus type 2"
          }
        ]
      },
      "valueBoolean": true,
      "exclude": false
    }
  ]
}

GET Group - Search by Parameter

Searches group resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Group?patient=example
Parameters
patientreference<example>
typetoken<person|practitioner|device|animal>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Group?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5d60bb0d",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Group?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Group/example",
      "resource": {
        "resourceType": "Group",
        "id": "example",
        "type": "person",
        "actual": true,
        "name": "Type 2 Diabetes Cohort",
        "quantity": 152,
        "managingEntity": {
          "reference": "Organization/nexapoint-health",
          "display": "NexaPoint Health"
        },
        "characteristic": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "44054006",
                  "display": "Diabetes mellitus type 2"
                }
              ]
            },
            "valueBoolean": true,
            "exclude": false
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Group - Search by Parameter

Searches group resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Group/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Group/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-700e4f28",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Group/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Group/example",
      "resource": {
        "resourceType": "Group",
        "id": "example",
        "type": "person",
        "actual": true,
        "name": "Type 2 Diabetes Cohort",
        "quantity": 152,
        "managingEntity": {
          "reference": "Organization/nexapoint-health",
          "display": "NexaPoint Health"
        },
        "characteristic": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "44054006",
                  "display": "Diabetes mellitus type 2"
                }
              ]
            },
            "valueBoolean": true,
            "exclude": false
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Immunization Resource Endpoints

The Immunization API conforms to the US Core Immunization Profile, providing access to patient immunization records.

GET Immunization - Read by ID

Retrieves a specific immunization record by its logical ID. Requires patient/Immunization.read or patient/Immunization.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Immunization/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Immunization/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Immunization",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
    ]
  },
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "208",
        "display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
      }
    ],
    "text": "COVID-19 mRNA vaccine"
  },
  "patient": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "occurrenceDateTime": "2024-01-12T10:30:00-05:00",
  "primarySource": true,
  "location": {
    "reference": "Location/clinic-1",
    "display": "NexaPoint Family Clinic"
  },
  "lotNumber": "EW0182",
  "expirationDate": "2024-09-30",
  "site": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
        "code": "LA",
        "display": "Left arm"
      }
    ]
  },
  "route": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
        "code": "IM",
        "display": "Intramuscular"
      }
    ]
  },
  "doseQuantity": {
    "value": 0.3,
    "unit": "mL",
    "system": "http://unitsofmeasure.org",
    "code": "mL"
  },
  "performer": [
    {
      "function": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
            "code": "AP",
            "display": "Administering Provider"
          }
        ]
      },
      "actor": {
        "reference": "Practitioner/practitioner-1",
        "display": "Dr. Ronald Bone"
      }
    }
  ]
}

GET Immunization - Search by Parameter

Searches immunization resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Immunization?patient=example&status=completed
Parameters
patientreference<example>
statustoken<completed|entered-in-error>
datedate<gt2023-01-01>
Example RequestSearch Completed
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Immunization?patient=example&status=completed"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-56bd6ef7",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Immunization?patient=example&status=completed"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Immunization/example",
      "resource": {
        "resourceType": "Immunization",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
          ]
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "208",
              "display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
            }
          ],
          "text": "COVID-19 mRNA vaccine"
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "occurrenceDateTime": "2024-01-12T10:30:00-05:00",
        "primarySource": true,
        "location": {
          "reference": "Location/clinic-1",
          "display": "NexaPoint Family Clinic"
        },
        "lotNumber": "EW0182",
        "expirationDate": "2024-09-30",
        "site": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
              "code": "LA",
              "display": "Left arm"
            }
          ]
        },
        "route": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
              "code": "IM",
              "display": "Intramuscular"
            }
          ]
        },
        "doseQuantity": {
          "value": 0.3,
          "unit": "mL",
          "system": "http://unitsofmeasure.org",
          "code": "mL"
        },
        "performer": [
          {
            "function": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
                  "code": "AP",
                  "display": "Administering Provider"
                }
              ]
            },
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Immunization - Search by Parameter

Searches immunization resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Immunization/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
statustoken<completed>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Immunization/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "status=completed"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-f0d1a1ac",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Immunization/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Immunization/example",
      "resource": {
        "resourceType": "Immunization",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
          ]
        },
        "status": "completed",
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "208",
              "display": "COVID-19, mRNA, LNP-S, PF, 30 mcg/0.3 mL dose"
            }
          ],
          "text": "COVID-19 mRNA vaccine"
        },
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "occurrenceDateTime": "2024-01-12T10:30:00-05:00",
        "primarySource": true,
        "location": {
          "reference": "Location/clinic-1",
          "display": "NexaPoint Family Clinic"
        },
        "lotNumber": "EW0182",
        "expirationDate": "2024-09-30",
        "site": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
              "code": "LA",
              "display": "Left arm"
            }
          ]
        },
        "route": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
              "code": "IM",
              "display": "Intramuscular"
            }
          ]
        },
        "doseQuantity": {
          "value": 0.3,
          "unit": "mL",
          "system": "http://unitsofmeasure.org",
          "code": "mL"
        },
        "performer": [
          {
            "function": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
                  "code": "AP",
                  "display": "Administering Provider"
                }
              ]
            },
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Location Resource Endpoints

Conforms to the US Core Location Profile, describing physical service-delivery locations referenced by encounters and practitioner roles.

GET Location - Read by ID

Retrieves a specific location record by its logical ID. Requires patient/Location.read or patient/Location.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Location/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Location/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Location",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
    ]
  },
  "status": "active",
  "name": "NexaPoint Family Clinic - Tulsa",
  "description": "Primary care outpatient clinic",
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "OUTPHARM",
          "display": "Outpatient Pharmacy"
        }
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+1-918-555-0142",
      "use": "work"
    }
  ],
  "address": {
    "use": "work",
    "line": [
      "1500 S Lewis Ave"
    ],
    "city": "Tulsa",
    "state": "OK",
    "postalCode": "74104",
    "country": "US"
  },
  "managingOrganization": {
    "reference": "Organization/nexapoint-health",
    "display": "NexaPoint Health"
  }
}

GET Location - Search by Parameter

Searches location resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Location?name=NexaPoint
Parameters
namestring<NexaPoint>
address-citystring<Tulsa>
address-statetoken<OK>
address-postalcodestring<74104>
Example RequestSearch by Name
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Location?name=NexaPoint"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-14462364",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Location?name=NexaPoint"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Location/example",
      "resource": {
        "resourceType": "Location",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
          ]
        },
        "status": "active",
        "name": "NexaPoint Family Clinic - Tulsa",
        "description": "Primary care outpatient clinic",
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "OUTPHARM",
                "display": "Outpatient Pharmacy"
              }
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0142",
            "use": "work"
          }
        ],
        "address": {
          "use": "work",
          "line": [
            "1500 S Lewis Ave"
          ],
          "city": "Tulsa",
          "state": "OK",
          "postalCode": "74104",
          "country": "US"
        },
        "managingOrganization": {
          "reference": "Organization/nexapoint-health",
          "display": "NexaPoint Health"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Location - Search by Parameter

Searches location resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Location/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
namestring<NexaPoint>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Location/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "name=NexaPoint"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5b92397e",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Location/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Location/example",
      "resource": {
        "resourceType": "Location",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
          ]
        },
        "status": "active",
        "name": "NexaPoint Family Clinic - Tulsa",
        "description": "Primary care outpatient clinic",
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "OUTPHARM",
                "display": "Outpatient Pharmacy"
              }
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0142",
            "use": "work"
          }
        ],
        "address": {
          "use": "work",
          "line": [
            "1500 S Lewis Ave"
          ],
          "city": "Tulsa",
          "state": "OK",
          "postalCode": "74104",
          "country": "US"
        },
        "managingOrganization": {
          "reference": "Organization/nexapoint-health",
          "display": "NexaPoint Health"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

MedicationDispense Resource Endpoints

Conforms to the US Core MedicationDispense Profile, returning pharmacy dispensing events for the patient.

GET MedicationDispense - Read by ID

Retrieves a specific medicationdispense record by its logical ID. Requires patient/MedicationDispense.read or patient/MedicationDispense.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "MedicationDispense",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense"
    ]
  },
  "status": "completed",
  "medicationReference": {
    "reference": "Medication/example",
    "display": "Acetaminophen 325 mg tablet"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "performer": [
    {
      "actor": {
        "reference": "Practitioner/practitioner-1",
        "display": "Dr. Ronald Bone"
      }
    }
  ],
  "authorizingPrescription": [
    {
      "reference": "MedicationRequest/example"
    }
  ],
  "quantity": {
    "value": 30,
    "unit": "tablet",
    "system": "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm",
    "code": "TAB"
  },
  "daysSupply": {
    "value": 30,
    "unit": "days",
    "system": "http://unitsofmeasure.org",
    "code": "d"
  },
  "whenHandedOver": "2024-02-09T11:00:00-05:00",
  "dosageInstruction": [
    {
      "text": "Take 1 tablet by mouth every 6 hours as needed for pain",
      "timing": {
        "repeat": {
          "frequency": 1,
          "period": 6,
          "periodUnit": "h"
        }
      },
      "route": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "26643006",
            "display": "Oral route"
          }
        ]
      }
    }
  ]
}

GET MedicationDispense - Search by Parameter

Searches medicationdispense resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/MedicationDispense?patient=example
Parameters
patientreference<example>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-996b75ad",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/example",
      "resource": {
        "resourceType": "MedicationDispense",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense"
          ]
        },
        "status": "completed",
        "medicationReference": {
          "reference": "Medication/example",
          "display": "Acetaminophen 325 mg tablet"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          }
        ],
        "authorizingPrescription": [
          {
            "reference": "MedicationRequest/example"
          }
        ],
        "quantity": {
          "value": 30,
          "unit": "tablet",
          "system": "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm",
          "code": "TAB"
        },
        "daysSupply": {
          "value": 30,
          "unit": "days",
          "system": "http://unitsofmeasure.org",
          "code": "d"
        },
        "whenHandedOver": "2024-02-09T11:00:00-05:00",
        "dosageInstruction": [
          {
            "text": "Take 1 tablet by mouth every 6 hours as needed for pain",
            "timing": {
              "repeat": {
                "frequency": 1,
                "period": 6,
                "periodUnit": "h"
              }
            },
            "route": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "26643006",
                  "display": "Oral route"
                }
              ]
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST MedicationDispense - Search by Parameter

Searches medicationdispense resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b20520e1",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/MedicationDispense/example",
      "resource": {
        "resourceType": "MedicationDispense",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationdispense"
          ]
        },
        "status": "completed",
        "medicationReference": {
          "reference": "Medication/example",
          "display": "Acetaminophen 325 mg tablet"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            }
          }
        ],
        "authorizingPrescription": [
          {
            "reference": "MedicationRequest/example"
          }
        ],
        "quantity": {
          "value": 30,
          "unit": "tablet",
          "system": "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm",
          "code": "TAB"
        },
        "daysSupply": {
          "value": 30,
          "unit": "days",
          "system": "http://unitsofmeasure.org",
          "code": "d"
        },
        "whenHandedOver": "2024-02-09T11:00:00-05:00",
        "dosageInstruction": [
          {
            "text": "Take 1 tablet by mouth every 6 hours as needed for pain",
            "timing": {
              "repeat": {
                "frequency": 1,
                "period": 6,
                "periodUnit": "h"
              }
            },
            "route": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "26643006",
                  "display": "Oral route"
                }
              ]
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

MedicationRequest Resource Endpoints

Conforms to the US Core MedicationRequest Profile, returning active and historical prescriptions for the patient.

GET MedicationRequest - Read by ID

Retrieves a specific medicationrequest record by its logical ID. Requires patient/MedicationRequest.read or patient/MedicationRequest.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "MedicationRequest",
  "id": "example",
  "meta": {
    "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": "outpatient"
        }
      ]
    }
  ],
  "medicationReference": {
    "reference": "Medication/example",
    "display": "Acetaminophen 325 mg tablet"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "authoredOn": "2024-02-08T14:30:00-05:00",
  "requester": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  },
  "reasonCode": [
    {
      "text": "Mild post-procedure pain"
    }
  ],
  "dosageInstruction": [
    {
      "text": "Take 1 tablet by mouth every 6 hours as needed",
      "timing": {
        "repeat": {
          "frequency": 1,
          "period": 6,
          "periodUnit": "h"
        }
      },
      "route": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "26643006",
            "display": "Oral route"
          }
        ]
      },
      "doseAndRate": [
        {
          "doseQuantity": {
            "value": 1,
            "unit": "tablet"
          }
        }
      ]
    }
  ],
  "dispenseRequest": {
    "numberOfRepeatsAllowed": 2,
    "quantity": {
      "value": 30,
      "unit": "tablet"
    }
  }
}

GET MedicationRequest - Search by Parameter

Searches medicationrequest resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/MedicationRequest?patient=example
Parameters
patientreference<example>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-3bda9421",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/example",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "example",
        "meta": {
          "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": "outpatient"
              }
            ]
          }
        ],
        "medicationReference": {
          "reference": "Medication/example",
          "display": "Acetaminophen 325 mg tablet"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "authoredOn": "2024-02-08T14:30:00-05:00",
        "requester": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "reasonCode": [
          {
            "text": "Mild post-procedure pain"
          }
        ],
        "dosageInstruction": [
          {
            "text": "Take 1 tablet by mouth every 6 hours as needed",
            "timing": {
              "repeat": {
                "frequency": 1,
                "period": 6,
                "periodUnit": "h"
              }
            },
            "route": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "26643006",
                  "display": "Oral route"
                }
              ]
            },
            "doseAndRate": [
              {
                "doseQuantity": {
                  "value": 1,
                  "unit": "tablet"
                }
              }
            ]
          }
        ],
        "dispenseRequest": {
          "numberOfRepeatsAllowed": 2,
          "quantity": {
            "value": 30,
            "unit": "tablet"
          }
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST MedicationRequest - Search by Parameter

Searches medicationrequest resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-27e1b35c",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/MedicationRequest/example",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "example",
        "meta": {
          "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": "outpatient"
              }
            ]
          }
        ],
        "medicationReference": {
          "reference": "Medication/example",
          "display": "Acetaminophen 325 mg tablet"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "authoredOn": "2024-02-08T14:30:00-05:00",
        "requester": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "reasonCode": [
          {
            "text": "Mild post-procedure pain"
          }
        ],
        "dosageInstruction": [
          {
            "text": "Take 1 tablet by mouth every 6 hours as needed",
            "timing": {
              "repeat": {
                "frequency": 1,
                "period": 6,
                "periodUnit": "h"
              }
            },
            "route": {
              "coding": [
                {
                  "system": "http://snomed.info/sct",
                  "code": "26643006",
                  "display": "Oral route"
                }
              ]
            },
            "doseAndRate": [
              {
                "doseQuantity": {
                  "value": 1,
                  "unit": "tablet"
                }
              }
            ]
          }
        ],
        "dispenseRequest": {
          "numberOfRepeatsAllowed": 2,
          "quantity": {
            "value": 30,
            "unit": "tablet"
          }
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Blood Pressure) Resource Endpoints

Conforms to the US Core Blood Pressure Profile. Returns systolic and diastolic vital signs as compound components.

GET Observation - Blood Pressure - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-12
Parameters
idstring<example-12>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-12
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-12",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: blood-pressure</p><p><b>meta</b>: </p><p><b>identifier</b>: urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281</p><p><b>basedOn</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Blood pressure systolic &amp; diastolic <span>(Details : {LOINC code '85354-9' = 'Blood pressure panel with all children optional', given as 'Blood pressure panel with all children optional'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 17/09/2012</p><p><b>performer</b>: <a>Practitioner/example</a></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p><p><b>bodySite</b>: Right arm <span>(Details : {SNOMED CT code '368209003' = 'Right upper arm', given as 'Right arm'})</span></p><blockquote><p><b>component</b></p><p><b>code</b>: Systolic blood pressure <span>(Details : {LOINC code '8480-6' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {SNOMED CT code '271649006' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {http://acme.org/devices/clinical-codes code 'bp-s' = 'bp-s', given as 'Systolic Blood pressure'})</span></p><p><b>value</b>: 107 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'N' = 'Normal', given as 'normal'})</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Diastolic blood pressure <span>(Details : {LOINC code '8462-4' = 'Diastolic blood pressure', given as 'Diastolic blood pressure'})</span></p><p><b>value</b>: 60 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p></blockquote></div>"
  },
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281"
    }
  ],
  "basedOn": [
    {
      "identifier": {
        "system": "https://acme.org/identifiers",
        "value": "1234"
      }
    }
  ],
  "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 systolic & diastolic"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "2012-09-17",
  "performer": [
    {
      "reference": "Practitioner/example"
    }
  ],
  "interpretation": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
          "code": "L",
          "display": "low"
        }
      ],
      "text": "Below low normal"
    }
  ],
  "bodySite": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "368209003",
        "display": "Right arm"
      }
    ]
  },
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8480-6",
            "display": "Systolic blood pressure"
          },
          {
            "system": "http://snomed.info/sct",
            "code": "271649006",
            "display": "Systolic blood pressure"
          },
          {
            "system": "http://acme.org/devices/clinical-codes",
            "code": "bp-s",
            "display": "Systolic Blood pressure"
          }
        ]
      },
      "valueQuantity": {
        "value": 107,
        "unit": "mmHg",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      },
      "interpretation": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
              "code": "N",
              "display": "normal"
            }
          ],
          "text": "Normal"
        }
      ]
    },
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "8462-4",
            "display": "Diastolic blood pressure"
          }
        ]
      },
      "valueQuantity": {
        "value": 60,
        "unit": "mmHg",
        "system": "http://unitsofmeasure.org",
        "code": "mm[Hg]"
      },
      "interpretation": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
              "code": "L",
              "display": "low"
            }
          ],
          "text": "Below low normal"
        }
      ]
    }
  ]
}

GET Observation - Blood Pressure - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=85354-9
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<85354-9>
datedate<gt2023-01-01>
Example RequestSearch Blood Pressure
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=85354-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-77a812d7",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=85354-9"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-12",
      "resource": {
        "resourceType": "Observation",
        "id": "example-12",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: blood-pressure</p><p><b>meta</b>: </p><p><b>identifier</b>: urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281</p><p><b>basedOn</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Blood pressure systolic &amp; diastolic <span>(Details : {LOINC code '85354-9' = 'Blood pressure panel with all children optional', given as 'Blood pressure panel with all children optional'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 17/09/2012</p><p><b>performer</b>: <a>Practitioner/example</a></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p><p><b>bodySite</b>: Right arm <span>(Details : {SNOMED CT code '368209003' = 'Right upper arm', given as 'Right arm'})</span></p><blockquote><p><b>component</b></p><p><b>code</b>: Systolic blood pressure <span>(Details : {LOINC code '8480-6' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {SNOMED CT code '271649006' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {http://acme.org/devices/clinical-codes code 'bp-s' = 'bp-s', given as 'Systolic Blood pressure'})</span></p><p><b>value</b>: 107 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'N' = 'Normal', given as 'normal'})</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Diastolic blood pressure <span>(Details : {LOINC code '8462-4' = 'Diastolic blood pressure', given as 'Diastolic blood pressure'})</span></p><p><b>value</b>: 60 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p></blockquote></div>"
        },
        "identifier": [
          {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281"
          }
        ],
        "basedOn": [
          {
            "identifier": {
              "system": "https://acme.org/identifiers",
              "value": "1234"
            }
          }
        ],
        "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 systolic & diastolic"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "2012-09-17",
        "performer": [
          {
            "reference": "Practitioner/example"
          }
        ],
        "interpretation": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "code": "L",
                "display": "low"
              }
            ],
            "text": "Below low normal"
          }
        ],
        "bodySite": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "368209003",
              "display": "Right arm"
            }
          ]
        },
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8480-6",
                  "display": "Systolic blood pressure"
                },
                {
                  "system": "http://snomed.info/sct",
                  "code": "271649006",
                  "display": "Systolic blood pressure"
                },
                {
                  "system": "http://acme.org/devices/clinical-codes",
                  "code": "bp-s",
                  "display": "Systolic Blood pressure"
                }
              ]
            },
            "valueQuantity": {
              "value": 107,
              "unit": "mmHg",
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "N",
                    "display": "normal"
                  }
                ],
                "text": "Normal"
              }
            ]
          },
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8462-4",
                  "display": "Diastolic blood pressure"
                }
              ]
            },
            "valueQuantity": {
              "value": 60,
              "unit": "mmHg",
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "L",
                    "display": "low"
                  }
                ],
                "text": "Below low normal"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Blood Pressure - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<85354-9>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=85354-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-8b5a5fb6",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-12",
      "resource": {
        "resourceType": "Observation",
        "id": "example-12",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: blood-pressure</p><p><b>meta</b>: </p><p><b>identifier</b>: urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281</p><p><b>basedOn</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Blood pressure systolic &amp; diastolic <span>(Details : {LOINC code '85354-9' = 'Blood pressure panel with all children optional', given as 'Blood pressure panel with all children optional'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 17/09/2012</p><p><b>performer</b>: <a>Practitioner/example</a></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p><p><b>bodySite</b>: Right arm <span>(Details : {SNOMED CT code '368209003' = 'Right upper arm', given as 'Right arm'})</span></p><blockquote><p><b>component</b></p><p><b>code</b>: Systolic blood pressure <span>(Details : {LOINC code '8480-6' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {SNOMED CT code '271649006' = 'Systolic blood pressure', given as 'Systolic blood pressure'}; {http://acme.org/devices/clinical-codes code 'bp-s' = 'bp-s', given as 'Systolic Blood pressure'})</span></p><p><b>value</b>: 107 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'N' = 'Normal', given as 'normal'})</span></p></blockquote><blockquote><p><b>component</b></p><p><b>code</b>: Diastolic blood pressure <span>(Details : {LOINC code '8462-4' = 'Diastolic blood pressure', given as 'Diastolic blood pressure'})</span></p><p><b>value</b>: 60 mmHg<span> (Details: UCUM code mm[Hg] = 'mmHg')</span></p><p><b>interpretation</b>: Below low normal <span>(Details : {http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation code 'L' = 'Low', given as 'low'})</span></p></blockquote></div>"
        },
        "identifier": [
          {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:uuid:187e0c12-8dd2-67e2-99b2-bf273c878281"
          }
        ],
        "basedOn": [
          {
            "identifier": {
              "system": "https://acme.org/identifiers",
              "value": "1234"
            }
          }
        ],
        "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 systolic & diastolic"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "2012-09-17",
        "performer": [
          {
            "reference": "Practitioner/example"
          }
        ],
        "interpretation": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "code": "L",
                "display": "low"
              }
            ],
            "text": "Below low normal"
          }
        ],
        "bodySite": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "368209003",
              "display": "Right arm"
            }
          ]
        },
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8480-6",
                  "display": "Systolic blood pressure"
                },
                {
                  "system": "http://snomed.info/sct",
                  "code": "271649006",
                  "display": "Systolic blood pressure"
                },
                {
                  "system": "http://acme.org/devices/clinical-codes",
                  "code": "bp-s",
                  "display": "Systolic Blood pressure"
                }
              ]
            },
            "valueQuantity": {
              "value": 107,
              "unit": "mmHg",
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "N",
                    "display": "normal"
                  }
                ],
                "text": "Normal"
              }
            ]
          },
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "8462-4",
                  "display": "Diastolic blood pressure"
                }
              ]
            },
            "valueQuantity": {
              "value": 60,
              "unit": "mmHg",
              "system": "http://unitsofmeasure.org",
              "code": "mm[Hg]"
            },
            "interpretation": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                    "code": "L",
                    "display": "low"
                  }
                ],
                "text": "Below low normal"
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (BMI) Resource Endpoints

Conforms to the US Core BMI Profile (LOINC 39156-5).

GET Observation - BMI - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-11
Parameters
idstring<example-11>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-11
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-11",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: bmi</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: BMI <span>(Details : {LOINC code '39156-5' = 'Body mass index (BMI) [Ratio]', given as 'Body mass index (BMI) [Ratio]'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 16.2 kg/m2<span> (Details: UCUM code kg/m2 = 'kg/m2')</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "39156-5",
        "display": "Body mass index (BMI) [Ratio]"
      }
    ],
    "text": "BMI"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "1999-07-02",
  "valueQuantity": {
    "value": 16.2,
    "unit": "kg/m2",
    "system": "http://unitsofmeasure.org",
    "code": "kg/m2"
  }
}

GET Observation - BMI - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=39156-5
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<39156-5>
datedate<gt2023-01-01>
Example RequestSearch BMI
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=39156-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-1e2b1bc5",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=39156-5"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-11",
      "resource": {
        "resourceType": "Observation",
        "id": "example-11",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: bmi</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: BMI <span>(Details : {LOINC code '39156-5' = 'Body mass index (BMI) [Ratio]', given as 'Body mass index (BMI) [Ratio]'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 16.2 kg/m2<span> (Details: UCUM code kg/m2 = 'kg/m2')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "39156-5",
              "display": "Body mass index (BMI) [Ratio]"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 16.2,
          "unit": "kg/m2",
          "system": "http://unitsofmeasure.org",
          "code": "kg/m2"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - BMI - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<39156-5>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=39156-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-a1fa2069",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-11",
      "resource": {
        "resourceType": "Observation",
        "id": "example-11",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: bmi</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: BMI <span>(Details : {LOINC code '39156-5' = 'Body mass index (BMI) [Ratio]', given as 'Body mass index (BMI) [Ratio]'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 16.2 kg/m2<span> (Details: UCUM code kg/m2 = 'kg/m2')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "39156-5",
              "display": "Body mass index (BMI) [Ratio]"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 16.2,
          "unit": "kg/m2",
          "system": "http://unitsofmeasure.org",
          "code": "kg/m2"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Body Height) Resource Endpoints

Conforms to the US Core Body Height Profile (LOINC 8302-2).

GET Observation - Body Height - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-17
Parameters
idstring<example-17>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-17
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-17",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation height</b></p><a name="height"> </a><a name="hcheight"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-body-height.html">US Core Body Height Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8302-2}">height</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 1999-07-02</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 111.506 cm<span style="background: LightGoldenRodYellow"> (Details: UCUM  codecm = 'cm')</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "8302-2",
        "display": "Body height"
      }
    ],
    "text": "height"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy Shaw"
  },
  "encounter": {
    "display": "GP Visit"
  },
  "effectiveDateTime": "1999-07-02",
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueQuantity": {
    "value": 111.506,
    "unit": "cm",
    "system": "http://unitsofmeasure.org",
    "code": "cm"
  }
}

GET Observation - Body Height - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8302-2
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<8302-2>
datedate<gt2023-01-01>
Example RequestSearch Body Height
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8302-2"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-2f1b7d21",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8302-2"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-17",
      "resource": {
        "resourceType": "Observation",
        "id": "example-17",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation height</b></p><a name="height"> </a><a name="hcheight"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-body-height.html">US Core Body Height Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8302-2}">height</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 1999-07-02</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 111.506 cm<span style="background: LightGoldenRodYellow"> (Details: UCUM  codecm = 'cm')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8302-2",
              "display": "Body height"
            }
          ],
          "text": "height"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "1999-07-02",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 111.506,
          "unit": "cm",
          "system": "http://unitsofmeasure.org",
          "code": "cm"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Body Height - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<8302-2>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=8302-2"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-c810ce8d",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-17",
      "resource": {
        "resourceType": "Observation",
        "id": "example-17",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation height</b></p><a name="height"> </a><a name="hcheight"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-body-height.html">US Core Body Height Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8302-2}">height</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 1999-07-02</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 111.506 cm<span style="background: LightGoldenRodYellow"> (Details: UCUM  codecm = 'cm')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8302-2",
              "display": "Body height"
            }
          ],
          "text": "height"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "1999-07-02",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 111.506,
          "unit": "cm",
          "system": "http://unitsofmeasure.org",
          "code": "cm"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Body Temperature) Resource Endpoints

Conforms to the US Core Body Temperature Profile (LOINC 8310-5).

GET Observation - Body Temperature - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-8
Parameters
idstring<example-8>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-8
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-8",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: body-temperature</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Body temperature <span>(Details : {LOINC code '8310-5' = 'Body temperature', given as 'Body temperature'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 36.5 C<span> (Details: UCUM code Cel = 'Cel')</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "8310-5",
        "display": "Body temperature"
      }
    ],
    "text": "Body temperature"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "1999-07-02",
  "valueQuantity": {
    "value": 36.5,
    "unit": "C",
    "system": "http://unitsofmeasure.org",
    "code": "Cel"
  }
}

GET Observation - Body Temperature - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8310-5
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<8310-5>
datedate<gt2023-01-01>
Example RequestSearch Body Temperature
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8310-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-8983d2dd",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8310-5"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-8",
      "resource": {
        "resourceType": "Observation",
        "id": "example-8",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: body-temperature</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Body temperature <span>(Details : {LOINC code '8310-5' = 'Body temperature', given as 'Body temperature'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 36.5 C<span> (Details: UCUM code Cel = 'Cel')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8310-5",
              "display": "Body temperature"
            }
          ],
          "text": "Body temperature"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 36.5,
          "unit": "C",
          "system": "http://unitsofmeasure.org",
          "code": "Cel"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Body Temperature - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<8310-5>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=8310-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-6c34ee5b",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-8",
      "resource": {
        "resourceType": "Observation",
        "id": "example-8",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: body-temperature</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Body temperature <span>(Details : {LOINC code '8310-5' = 'Body temperature', given as 'Body temperature'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 36.5 C<span> (Details: UCUM code Cel = 'Cel')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8310-5",
              "display": "Body temperature"
            }
          ],
          "text": "Body temperature"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 36.5,
          "unit": "C",
          "system": "http://unitsofmeasure.org",
          "code": "Cel"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Head Circumference) Resource Endpoints

Conforms to the US Core Head Circumference Profile (LOINC 9843-4).

GET Observation - Head Circumference - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-10
Parameters
idstring<example-10>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-10
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-10",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: head-circumference</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Head Circumference <span>(Details : {LOINC code '9843-4' = 'Head Occipital-frontal circumference', given as 'Head Occipital-frontal circumference'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 51.2 cm<span> (Details: UCUM code cm = 'cm')</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "9843-4",
        "display": "Head Occipital-frontal circumference"
      }
    ],
    "text": "Head Circumference"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "1999-07-02",
  "valueQuantity": {
    "value": 51.2,
    "unit": "cm",
    "system": "http://unitsofmeasure.org",
    "code": "cm"
  }
}

GET Observation - Head Circumference - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9843-4
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<9843-4>
datedate<gt2023-01-01>
Example RequestSearch Head Circumference
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9843-4"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-eeaac216",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9843-4"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-10",
      "resource": {
        "resourceType": "Observation",
        "id": "example-10",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: head-circumference</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Head Circumference <span>(Details : {LOINC code '9843-4' = 'Head Occipital-frontal circumference', given as 'Head Occipital-frontal circumference'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 51.2 cm<span> (Details: UCUM code cm = 'cm')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "9843-4",
              "display": "Head Occipital-frontal circumference"
            }
          ],
          "text": "Head Circumference"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 51.2,
          "unit": "cm",
          "system": "http://unitsofmeasure.org",
          "code": "cm"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Head Circumference - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<9843-4>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=9843-4"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5a5da5b1",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-10",
      "resource": {
        "resourceType": "Observation",
        "id": "example-10",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: head-circumference</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Head Circumference <span>(Details : {LOINC code '9843-4' = 'Head Occipital-frontal circumference', given as 'Head Occipital-frontal circumference'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 51.2 cm<span> (Details: UCUM code cm = 'cm')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "9843-4",
              "display": "Head Occipital-frontal circumference"
            }
          ],
          "text": "Head Circumference"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 51.2,
          "unit": "cm",
          "system": "http://unitsofmeasure.org",
          "code": "cm"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Head OFC Percentile) Resource Endpoints

Conforms to the US Core Pediatric Head Occipital-Frontal Circumference Percentile Profile (LOINC 8289-1).

GET Observation - Head Occipital-Frontal Circumference Percentile - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/ofc-percentile
Parameters
idstring<ofc-percentile>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/ofc-percentile
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "ofc-percentile",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation ofc-percentile</b></p><a name="ofc-percentile"> </a><a name="hcofc-percentile"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-head-occipital-frontal-circumference-percentile.html">US Core Pediatric Head Occipital Frontal Circumference Percentile Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8289-1}">Head Occipital-frontal circumference Percentile</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Infant Example</a></p><p><b>effective</b>: 2020-07-01</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 82 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>WHO Males, 0-2 years Chart</p>
</div></blockquote></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "8289-1",
        "display": "Head Occipital-frontal circumference Percentile"
      }
    ],
    "text": "Head Occipital-frontal circumference Percentile"
  },
  "subject": {
    "reference": "Patient/infant-example",
    "display": "Infant Example"
  },
  "effectiveDateTime": "2020-07-01",
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueQuantity": {
    "value": 82,
    "unit": "%",
    "system": "http://unitsofmeasure.org",
    "code": "%"
  },
  "note": [
    {
      "text": "WHO Males, 0-2 years Chart"
    }
  ]
}

GET Observation - Head Occipital-Frontal Circumference Percentile - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8289-1
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<8289-1>
datedate<gt2023-01-01>
Example RequestSearch OFC Percentile
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8289-1"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-3045bf09",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=8289-1"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/ofc-percentile",
      "resource": {
        "resourceType": "Observation",
        "id": "ofc-percentile",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation ofc-percentile</b></p><a name="ofc-percentile"> </a><a name="hcofc-percentile"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-head-occipital-frontal-circumference-percentile.html">US Core Pediatric Head Occipital Frontal Circumference Percentile Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8289-1}">Head Occipital-frontal circumference Percentile</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Infant Example</a></p><p><b>effective</b>: 2020-07-01</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 82 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>WHO Males, 0-2 years Chart</p>
</div></blockquote></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8289-1",
              "display": "Head Occipital-frontal circumference Percentile"
            }
          ],
          "text": "Head Occipital-frontal circumference Percentile"
        },
        "subject": {
          "reference": "Patient/infant-example",
          "display": "Infant Example"
        },
        "effectiveDateTime": "2020-07-01",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 82,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "WHO Males, 0-2 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Head Occipital-Frontal Circumference Percentile - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<8289-1>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=8289-1"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-7fa73c2b",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/ofc-percentile",
      "resource": {
        "resourceType": "Observation",
        "id": "ofc-percentile",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation ofc-percentile</b></p><a name="ofc-percentile"> </a><a name="hcofc-percentile"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-head-occipital-frontal-circumference-percentile.html">US Core Pediatric Head Occipital Frontal Circumference Percentile Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 8289-1}">Head Occipital-frontal circumference Percentile</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Infant Example</a></p><p><b>effective</b>: 2020-07-01</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 82 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>WHO Males, 0-2 years Chart</p>
</div></blockquote></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "8289-1",
              "display": "Head Occipital-frontal circumference Percentile"
            }
          ],
          "text": "Head Occipital-frontal circumference Percentile"
        },
        "subject": {
          "reference": "Patient/infant-example",
          "display": "Infant Example"
        },
        "effectiveDateTime": "2020-07-01",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 82,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "WHO Males, 0-2 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Laboratory Result) Resource Endpoints

Conforms to the US Core Laboratory Result Observation Profile. Returns laboratory observations identified by LOINC codes.

GET Observation - Lab Result - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-1
Parameters
idstring<example-1>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-1
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-1",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="cbc-erythrocytes"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;cbc-erythrocytes&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Laboratory <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#laboratory)</span></p><p><b>code</b>: Erythrocytes <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#789-8 &quot;Erythrocytes [#/volume] in Blood by Automated count&quot;)</span></p><p><b>subject</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p><p><b>effective</b>: 2005-07-05</p><p><b>value</b>: 4.58 10*6/uL</p><h3>ReferenceRanges</h3><table class="grid"><tr><td>-</td><td><b>Low</b></td><td><b>High</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>4.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>6.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>Normal Range <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-referencerange-meaning.html">Observation Reference Range Meaning Codes</a>#normal)</span></td></tr></table></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "laboratory",
          "display": "Laboratory"
        }
      ],
      "text": "Laboratory"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "789-8",
        "display": "Erythrocytes [#/volume] in Blood by Automated count"
      }
    ],
    "text": "Erythrocytes"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy Shaw"
  },
  "effectiveDateTime": "2005-07-05",
  "valueQuantity": {
    "value": 4.58,
    "unit": "10*6/uL",
    "system": "http://unitsofmeasure.org"
  },
  "referenceRange": [
    {
      "low": {
        "value": 4.1,
        "unit": "10*6/uL",
        "system": "http://unitsofmeasure.org",
        "code": "10*6/uL"
      },
      "high": {
        "value": 6.1,
        "unit": "10*6/uL",
        "system": "http://unitsofmeasure.org",
        "code": "10*6/uL"
      },
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
            "code": "normal",
            "display": "Normal Range"
          }
        ],
        "text": "Normal Range"
      }
    }
  ]
}

GET Observation - Lab Result - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=laboratory
Parameters
patientreference<example>
categorytoken<laboratory>
codetoken<LOINC code>
datedate<gt2023-01-01>
Example RequestSearch Lab Results
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=laboratory"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-d7316131",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=laboratory"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-1",
      "resource": {
        "resourceType": "Observation",
        "id": "example-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="cbc-erythrocytes"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;cbc-erythrocytes&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Laboratory <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#laboratory)</span></p><p><b>code</b>: Erythrocytes <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#789-8 &quot;Erythrocytes [#/volume] in Blood by Automated count&quot;)</span></p><p><b>subject</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p><p><b>effective</b>: 2005-07-05</p><p><b>value</b>: 4.58 10*6/uL</p><h3>ReferenceRanges</h3><table class="grid"><tr><td>-</td><td><b>Low</b></td><td><b>High</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>4.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>6.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>Normal Range <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-referencerange-meaning.html">Observation Reference Range Meaning Codes</a>#normal)</span></td></tr></table></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory",
                "display": "Laboratory"
              }
            ],
            "text": "Laboratory"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "789-8",
              "display": "Erythrocytes [#/volume] in Blood by Automated count"
            }
          ],
          "text": "Erythrocytes"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2005-07-05",
        "valueQuantity": {
          "value": 4.58,
          "unit": "10*6/uL",
          "system": "http://unitsofmeasure.org"
        },
        "referenceRange": [
          {
            "low": {
              "value": 4.1,
              "unit": "10*6/uL",
              "system": "http://unitsofmeasure.org",
              "code": "10*6/uL"
            },
            "high": {
              "value": 6.1,
              "unit": "10*6/uL",
              "system": "http://unitsofmeasure.org",
              "code": "10*6/uL"
            },
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                  "code": "normal",
                  "display": "Normal Range"
                }
              ],
              "text": "Normal Range"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Lab Result - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<laboratory>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=laboratory"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-bce2aa28",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-1",
      "resource": {
        "resourceType": "Observation",
        "id": "example-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="cbc-erythrocytes"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;cbc-erythrocytes&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-lab.html">US Core Laboratory Result Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Laboratory <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#laboratory)</span></p><p><b>code</b>: Erythrocytes <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#789-8 &quot;Erythrocytes [#/volume] in Blood by Automated count&quot;)</span></p><p><b>subject</b>: <a href="Patient-example.html">Patient/example: Amy Shaw</a> &quot; SHAW&quot;</p><p><b>effective</b>: 2005-07-05</p><p><b>value</b>: 4.58 10*6/uL</p><h3>ReferenceRanges</h3><table class="grid"><tr><td>-</td><td><b>Low</b></td><td><b>High</b></td><td><b>Type</b></td></tr><tr><td>*</td><td>4.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>6.1 10*6/uL<span style="background: LightGoldenRodYellow"> (Details: UCUM code 10*6/uL = '10*6/uL')</span></td><td>Normal Range <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-referencerange-meaning.html">Observation Reference Range Meaning Codes</a>#normal)</span></td></tr></table></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory",
                "display": "Laboratory"
              }
            ],
            "text": "Laboratory"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "789-8",
              "display": "Erythrocytes [#/volume] in Blood by Automated count"
            }
          ],
          "text": "Erythrocytes"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2005-07-05",
        "valueQuantity": {
          "value": 4.58,
          "unit": "10*6/uL",
          "system": "http://unitsofmeasure.org"
        },
        "referenceRange": [
          {
            "low": {
              "value": 4.1,
              "unit": "10*6/uL",
              "system": "http://unitsofmeasure.org",
              "code": "10*6/uL"
            },
            "high": {
              "value": 6.1,
              "unit": "10*6/uL",
              "system": "http://unitsofmeasure.org",
              "code": "10*6/uL"
            },
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/referencerange-meaning",
                  "code": "normal",
                  "display": "Normal Range"
                }
              ],
              "text": "Normal Range"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Occupation) Resource Endpoints

Conforms to the US Core Observation Occupation Profile, capturing employment status and industry/occupation codes.

GET Observation - Occupation - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/observation-occupation
Parameters
idstring<observation-occupation>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/observation-occupation
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "observation-occupation",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation observation-occupation</b></p><a name="observation-occupation"> </a><a name="hcobservation-occupation"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-occupation.html">US Core Observation Occupation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11341-5}">History of Occupation</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2015-04-24 --&gt; (ongoing)</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 31-1014.00.007136}">Certified Nursing Assistant (CNA) [Nursing Assistants]</span></p><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 86188-0}">History of Occupation Industry</span></td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 621610.008495}">Home nursing services</span></td></tr></table></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "social-history"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "11341-5",
        "display": "History of Occupation"
      }
    ]
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectivePeriod": {
    "start": "2015-04-24"
  },
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
        "code": "31-1014.00.007136",
        "display": "Certified Nursing Assistant (CNA) [Nursing Assistants]"
      }
    ]
  },
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "86188-0",
            "display": "History of Occupation Industry"
          }
        ]
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
            "code": "621610.008495",
            "display": "Home nursing services"
          }
        ]
      }
    }
  ]
}

GET Observation - Occupation - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=11341-5
Parameters
patientreference<example>
categorytoken<social-history>
codetoken<11341-5>
datedate<gt2023-01-01>
Example RequestSearch Occupation
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=11341-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-0f477ac9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=11341-5"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/observation-occupation",
      "resource": {
        "resourceType": "Observation",
        "id": "observation-occupation",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation observation-occupation</b></p><a name="observation-occupation"> </a><a name="hcobservation-occupation"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-occupation.html">US Core Observation Occupation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11341-5}">History of Occupation</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2015-04-24 --&gt; (ongoing)</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 31-1014.00.007136}">Certified Nursing Assistant (CNA) [Nursing Assistants]</span></p><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 86188-0}">History of Occupation Industry</span></td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 621610.008495}">Home nursing services</span></td></tr></table></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "11341-5",
              "display": "History of Occupation"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectivePeriod": {
          "start": "2015-04-24"
        },
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
              "code": "31-1014.00.007136",
              "display": "Certified Nursing Assistant (CNA) [Nursing Assistants]"
            }
          ]
        },
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "86188-0",
                  "display": "History of Occupation Industry"
                }
              ]
            },
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
                  "code": "621610.008495",
                  "display": "Home nursing services"
                }
              ]
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Occupation - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<11341-5>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=11341-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-30d08d06",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/observation-occupation",
      "resource": {
        "resourceType": "Observation",
        "id": "observation-occupation",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-occupation|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation observation-occupation</b></p><a name="observation-occupation"> </a><a name="hcobservation-occupation"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-occupation.html">US Core Observation Occupation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 11341-5}">History of Occupation</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2015-04-24 --&gt; (ongoing)</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 31-1014.00.007136}">Certified Nursing Assistant (CNA) [Nursing Assistants]</span></p><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 86188-0}">History of Occupation Industry</span></td><td><span title="Codes:{http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH 621610.008495}">Home nursing services</span></td></tr></table></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "11341-5",
              "display": "History of Occupation"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectivePeriod": {
          "start": "2015-04-24"
        },
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
              "code": "31-1014.00.007136",
              "display": "Certified Nursing Assistant (CNA) [Nursing Assistants]"
            }
          ]
        },
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "86188-0",
                  "display": "History of Occupation Industry"
                }
              ]
            },
            "valueCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/PHOccupationalDataForHealthODH",
                  "code": "621610.008495",
                  "display": "Home nursing services"
                }
              ]
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Pediatric BMI for Age) Resource Endpoints

Conforms to the US Core Pediatric BMI for Age Observation Profile (LOINC 59576-9).

GET Observation - Pediatric BMI for Age - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-19
Parameters
idstring<example-19>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-19
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-19",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pediatric-bmi-example</b></p><a name="pediatric-bmi-example"> </a><a name="hcpediatric-bmi-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-bmi-for-age.html">US Core Pediatric BMI for Age Observation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 59576-9}">BMI</span></p><p><b>subject</b>: <a href="Patient-child-example.html">Child Example</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 2019-05-04 12:12:29-0700</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>CDC Males, 2-20 years Chart</p>
</div></blockquote></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "59576-9",
        "display": "Body mass index (BMI) [Percentile] Per age and sex"
      }
    ],
    "text": "BMI"
  },
  "subject": {
    "reference": "Patient/child-example",
    "display": "Child Example"
  },
  "encounter": {
    "display": "GP Visit"
  },
  "effectiveDateTime": "2019-05-04T12:12:29-07:00",
  "performer": [
    {
      "reference": "Practitioner/example-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueQuantity": {
    "value": 65,
    "unit": "%",
    "system": "http://unitsofmeasure.org",
    "code": "%"
  },
  "note": [
    {
      "text": "CDC Males, 2-20 years Chart"
    }
  ]
}

GET Observation - Pediatric BMI for Age - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59576-9
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<59576-9>
datedate<gt2023-01-01>
Example RequestSearch Pediatric BMI-for-Age
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59576-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-fbd3bb88",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59576-9"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-19",
      "resource": {
        "resourceType": "Observation",
        "id": "example-19",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pediatric-bmi-example</b></p><a name="pediatric-bmi-example"> </a><a name="hcpediatric-bmi-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-bmi-for-age.html">US Core Pediatric BMI for Age Observation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 59576-9}">BMI</span></p><p><b>subject</b>: <a href="Patient-child-example.html">Child Example</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 2019-05-04 12:12:29-0700</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>CDC Males, 2-20 years Chart</p>
</div></blockquote></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "59576-9",
              "display": "Body mass index (BMI) [Percentile] Per age and sex"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/child-example",
          "display": "Child Example"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "2019-05-04T12:12:29-07:00",
        "performer": [
          {
            "reference": "Practitioner/example-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 65,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "CDC Males, 2-20 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Pediatric BMI for Age - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<59576-9>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=59576-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-17b57fb9",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-19",
      "resource": {
        "resourceType": "Observation",
        "id": "example-19",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pediatric-bmi-example</b></p><a name="pediatric-bmi-example"> </a><a name="hcpediatric-bmi-example"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-bmi-for-age.html">US Core Pediatric BMI for Age Observation Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 59576-9}">BMI</span></p><p><b>subject</b>: <a href="Patient-child-example.html">Child Example</a></p><p><b>encounter</b>: GP Visit</p><p><b>effective</b>: 2019-05-04 12:12:29-0700</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>note</b>: </p><blockquote><div><p>CDC Males, 2-20 years Chart</p>
</div></blockquote></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "59576-9",
              "display": "Body mass index (BMI) [Percentile] Per age and sex"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/child-example",
          "display": "Child Example"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "2019-05-04T12:12:29-07:00",
        "performer": [
          {
            "reference": "Practitioner/example-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 65,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "CDC Males, 2-20 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Pediatric Weight for Height) Resource Endpoints

Conforms to the US Core Pediatric Weight for Height Observation Profile (LOINC 77606-2).

GET Observation - Pediatric Weight for Height - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-14
Parameters
idstring<example-14>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-14
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-14",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="pediatric-wt-example"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;pediatric-wt-example&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-weight-for-height.html">US Core Pediatric Weight for Height Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#vital-signs)</span></p><p><b>code</b>: BMI <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#77606-2 &quot;Weight-for-length Per age and sex&quot;)</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Patient/infant-example: Infant Example</a> &quot; EXAMPLE&quot;</p><p><b>encounter</b>: <span>: GP Visit</span></p><p><b>effective</b>: 2020-07-02</p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM code % = '%')</span></p><p><b>note</b>: WHO Males, 0-2 years Chart</p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "77606-2",
        "display": "Weight-for-length Per age and sex"
      }
    ],
    "text": "BMI"
  },
  "subject": {
    "reference": "Patient/infant-example",
    "display": "Infant Example"
  },
  "encounter": {
    "display": "GP Visit"
  },
  "effectiveDateTime": "2020-07-02",
  "valueQuantity": {
    "value": 65,
    "unit": "%",
    "system": "http://unitsofmeasure.org",
    "code": "%"
  },
  "note": [
    {
      "text": "WHO Males, 0-2 years Chart"
    }
  ]
}

GET Observation - Pediatric Weight for Height - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=77606-2
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<77606-2>
datedate<gt2023-01-01>
Example RequestSearch Pediatric Wt-for-Ht
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=77606-2"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-7a20632c",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=77606-2"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-14",
      "resource": {
        "resourceType": "Observation",
        "id": "example-14",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="pediatric-wt-example"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;pediatric-wt-example&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-weight-for-height.html">US Core Pediatric Weight for Height Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#vital-signs)</span></p><p><b>code</b>: BMI <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#77606-2 &quot;Weight-for-length Per age and sex&quot;)</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Patient/infant-example: Infant Example</a> &quot; EXAMPLE&quot;</p><p><b>encounter</b>: <span>: GP Visit</span></p><p><b>effective</b>: 2020-07-02</p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM code % = '%')</span></p><p><b>note</b>: WHO Males, 0-2 years Chart</p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "77606-2",
              "display": "Weight-for-length Per age and sex"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/infant-example",
          "display": "Infant Example"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "2020-07-02",
        "valueQuantity": {
          "value": 65,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "WHO Males, 0-2 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Pediatric Weight for Height - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<77606-2>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=77606-2"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-91fc8bf8",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-14",
      "resource": {
        "resourceType": "Observation",
        "id": "example-14",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative: Observation</b><a name="pediatric-wt-example"> </a></p><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Resource Observation &quot;pediatric-wt-example&quot; </p><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-pediatric-weight-for-height.html">US Core Pediatric Weight for Height Observation Profile</a></p></div><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="http://terminology.hl7.org/5.0.0/CodeSystem-observation-category.html">Observation Category Codes</a>#vital-signs)</span></p><p><b>code</b>: BMI <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (<a href="https://loinc.org/">LOINC</a>#77606-2 &quot;Weight-for-length Per age and sex&quot;)</span></p><p><b>subject</b>: <a href="Patient-infant-example.html">Patient/infant-example: Infant Example</a> &quot; EXAMPLE&quot;</p><p><b>encounter</b>: <span>: GP Visit</span></p><p><b>effective</b>: 2020-07-02</p><p><b>value</b>: 65 %<span style="background: LightGoldenRodYellow"> (Details: UCUM code % = '%')</span></p><p><b>note</b>: WHO Males, 0-2 years Chart</p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "77606-2",
              "display": "Weight-for-length Per age and sex"
            }
          ],
          "text": "BMI"
        },
        "subject": {
          "reference": "Patient/infant-example",
          "display": "Infant Example"
        },
        "encounter": {
          "display": "GP Visit"
        },
        "effectiveDateTime": "2020-07-02",
        "valueQuantity": {
          "value": 65,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "note": [
          {
            "text": "WHO Males, 0-2 years Chart"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Pregnancy Intent) Resource Endpoints

Conforms to the US Core Observation Pregnancy Intent Profile (LOINC 86645-9).

GET Observation - Pregnancy Intent - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-13
Parameters
idstring<example-13>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-13
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-13",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-intent</b></p><a name="pregnancy-intent"> </a><a name="hcpregnancy-intent"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancyintent.html">US Core Observation Pregnancy Intent Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 86645-9}">Pregnancy Intent</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-09-23 22:39:43+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 454381000124105}">Pregnant</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "social-history",
          "display": "Social History"
        }
      ],
      "text": "Social History"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "86645-9",
        "display": "Pregnancy intention in the next year - Reported"
      }
    ],
    "text": "Pregnancy Intent"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy Shaw"
  },
  "effectiveDateTime": "2022-09-23T22:39:43+00:00",
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "version": "http://snomed.info/sct/731000124108",
        "code": "454381000124105",
        "display": "Not sure of desire to become pregnant (finding)"
      }
    ],
    "text": "Pregnant"
  }
}

GET Observation - Pregnancy Intent - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=86645-9
Parameters
patientreference<example>
codetoken<86645-9>
categorytoken<survey|social-history>
datedate<gt2023-01-01>
Example RequestSearch Pregnancy Intent
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=86645-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5ff6fb68",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=86645-9"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-13",
      "resource": {
        "resourceType": "Observation",
        "id": "example-13",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-intent</b></p><a name="pregnancy-intent"> </a><a name="hcpregnancy-intent"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancyintent.html">US Core Observation Pregnancy Intent Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 86645-9}">Pregnancy Intent</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-09-23 22:39:43+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 454381000124105}">Pregnant</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "86645-9",
              "display": "Pregnancy intention in the next year - Reported"
            }
          ],
          "text": "Pregnancy Intent"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2022-09-23T22:39:43+00:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "454381000124105",
              "display": "Not sure of desire to become pregnant (finding)"
            }
          ],
          "text": "Pregnant"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Pregnancy Intent - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<86645-9>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=86645-9"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-1003afbc",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-13",
      "resource": {
        "resourceType": "Observation",
        "id": "example-13",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancyintent|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-intent</b></p><a name="pregnancy-intent"> </a><a name="hcpregnancy-intent"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancyintent.html">US Core Observation Pregnancy Intent Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 86645-9}">Pregnancy Intent</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-09-23 22:39:43+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 454381000124105}">Pregnant</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "86645-9",
              "display": "Pregnancy intention in the next year - Reported"
            }
          ],
          "text": "Pregnancy Intent"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2022-09-23T22:39:43+00:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "454381000124105",
              "display": "Not sure of desire to become pregnant (finding)"
            }
          ],
          "text": "Pregnant"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Pregnancy Status) Resource Endpoints

Conforms to the US Core Observation Pregnancy Status Profile (LOINC 82810-3).

GET Observation - Pregnancy Status - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-9
Parameters
idstring<example-9>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-9
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-9",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-status</b></p><a name="pregnancy-status"> </a><a name="hcpregnancy-status"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancystatus.html">US Core Observation Pregnancy Status Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 82810-3}">Pregnancy Status</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-08-24 10:39:52+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 77386006}">Pregnant</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "social-history",
          "display": "Social History"
        }
      ],
      "text": "Social History"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "82810-3",
        "display": "Pregnancy status"
      }
    ],
    "text": "Pregnancy Status"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy Shaw"
  },
  "effectiveDateTime": "2022-08-24T10:39:52+00:00",
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueCodeableConcept": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "version": "http://snomed.info/sct/731000124108",
        "code": "77386006",
        "display": "Pregnant"
      }
    ],
    "text": "Pregnant"
  }
}

GET Observation - Pregnancy Status - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=82810-3
Parameters
patientreference<example>
codetoken<82810-3>
categorytoken<survey|social-history>
datedate<gt2023-01-01>
Example RequestSearch Pregnancy Status
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=82810-3"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-5abfd22a",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=82810-3"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-9",
      "resource": {
        "resourceType": "Observation",
        "id": "example-9",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-status</b></p><a name="pregnancy-status"> </a><a name="hcpregnancy-status"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancystatus.html">US Core Observation Pregnancy Status Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 82810-3}">Pregnancy Status</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-08-24 10:39:52+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 77386006}">Pregnant</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "82810-3",
              "display": "Pregnancy status"
            }
          ],
          "text": "Pregnancy Status"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2022-08-24T10:39:52+00:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "77386006",
              "display": "Pregnant"
            }
          ],
          "text": "Pregnant"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Pregnancy Status - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<82810-3>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=82810-3"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-58a64c24",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-9",
      "resource": {
        "resourceType": "Observation",
        "id": "example-9",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-pregnancystatus|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation pregnancy-status</b></p><a name="pregnancy-status"> </a><a name="hcpregnancy-status"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-observation-pregnancystatus.html">US Core Observation Pregnancy Status Profileversion: null8.0.1)</a></p></div><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category social-history}">Social History</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 82810-3}">Pregnancy Status</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy Shaw</a></p><p><b>effective</b>: 2022-08-24 10:39:52+0000</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: <span title="Codes:{http://snomed.info/sct 77386006}">Pregnant</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "82810-3",
              "display": "Pregnancy status"
            }
          ],
          "text": "Pregnancy Status"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy Shaw"
        },
        "effectiveDateTime": "2022-08-24T10:39:52+00:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "77386006",
              "display": "Pregnant"
            }
          ],
          "text": "Pregnant"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Pulse Oximetry) Resource Endpoints

Conforms to the US Core Pulse Oximetry Profile (LOINC 59408-5, with inspired-oxygen-concentration component).

GET Observation - Pulse Oximetry - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-16
Parameters
idstring<example-16>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-16
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-16",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation satO2-fiO2</b></p><a name="satO2-fiO2"> </a><a name="hcsatO2-fiO2"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-pulse-oximetry.html">US Core Pulse Oximetry Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://example.org/FHIR/observation/identifiers</code>/o1223435-10</p><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 2708-6}, {http://loinc.org 59408-5}, {urn:iso:std:iso:11073:10101 150456}">Oxygen saturation in Arterial blood</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2014-12-05 09:30:10+0100</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 95 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>interpretation</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation N}">Normal</span></p><p><b>device</b>: Acme Pulse Oximeter 2000</p><h3>ReferenceRanges</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Low</b></td><td><b>High</b></td></tr><tr><td style="display: none">*</td><td>90 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td><td>99 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td></tr></table><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 3151-8}">Inhaled oxygen flow rate</span></td><td>6 liters/min<span style="background: LightGoldenRodYellow"> (Details: UCUM  codeL/min = 'L/min')</span></td></tr></table></div>"
  },
  "identifier": [
    {
      "system": "http://example.org/FHIR/observation/identifiers",
      "value": "o1223435-10"
    }
  ],
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "2708-6",
        "display": "Oxygen saturation in Arterial blood"
      },
      {
        "system": "http://loinc.org",
        "code": "59408-5",
        "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
      },
      {
        "system": "urn:iso:std:iso:11073:10101",
        "code": "150456",
        "display": "MDC_PULS_OXIM_SAT_O2"
      }
    ]
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "2014-12-05T09:30:10+01:00",
  "performer": [
    {
      "reference": "Practitioner/practitioner-1",
      "display": "Dr Ronald Bone"
    }
  ],
  "valueQuantity": {
    "value": 95,
    "unit": "%",
    "system": "http://unitsofmeasure.org",
    "code": "%"
  },
  "interpretation": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
          "code": "N",
          "display": "Normal"
        }
      ],
      "text": "Normal"
    }
  ],
  "device": {
    "display": "Acme Pulse Oximeter 2000"
  },
  "referenceRange": [
    {
      "low": {
        "value": 90,
        "unit": "%",
        "system": "http://unitsofmeasure.org",
        "code": "%"
      },
      "high": {
        "value": 99,
        "unit": "%",
        "system": "http://unitsofmeasure.org",
        "code": "%"
      }
    }
  ],
  "component": [
    {
      "code": {
        "coding": [
          {
            "system": "http://loinc.org",
            "code": "3151-8",
            "display": "Inhaled oxygen flow rate"
          }
        ],
        "text": "Inhaled oxygen flow rate"
      },
      "valueQuantity": {
        "value": 6,
        "unit": "liters/min",
        "system": "http://unitsofmeasure.org",
        "code": "L/min"
      }
    }
  ]
}

GET Observation - Pulse Oximetry - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59408-5
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<59408-5>
datedate<gt2023-01-01>
Example RequestSearch Pulse Oximetry
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59408-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-3fba267b",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=59408-5"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-16",
      "resource": {
        "resourceType": "Observation",
        "id": "example-16",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation satO2-fiO2</b></p><a name="satO2-fiO2"> </a><a name="hcsatO2-fiO2"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-pulse-oximetry.html">US Core Pulse Oximetry Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://example.org/FHIR/observation/identifiers</code>/o1223435-10</p><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 2708-6}, {http://loinc.org 59408-5}, {urn:iso:std:iso:11073:10101 150456}">Oxygen saturation in Arterial blood</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2014-12-05 09:30:10+0100</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 95 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>interpretation</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation N}">Normal</span></p><p><b>device</b>: Acme Pulse Oximeter 2000</p><h3>ReferenceRanges</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Low</b></td><td><b>High</b></td></tr><tr><td style="display: none">*</td><td>90 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td><td>99 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td></tr></table><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 3151-8}">Inhaled oxygen flow rate</span></td><td>6 liters/min<span style="background: LightGoldenRodYellow"> (Details: UCUM  codeL/min = 'L/min')</span></td></tr></table></div>"
        },
        "identifier": [
          {
            "system": "http://example.org/FHIR/observation/identifiers",
            "value": "o1223435-10"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "2708-6",
              "display": "Oxygen saturation in Arterial blood"
            },
            {
              "system": "http://loinc.org",
              "code": "59408-5",
              "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
            },
            {
              "system": "urn:iso:std:iso:11073:10101",
              "code": "150456",
              "display": "MDC_PULS_OXIM_SAT_O2"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "2014-12-05T09:30:10+01:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 95,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "interpretation": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "code": "N",
                "display": "Normal"
              }
            ],
            "text": "Normal"
          }
        ],
        "device": {
          "display": "Acme Pulse Oximeter 2000"
        },
        "referenceRange": [
          {
            "low": {
              "value": 90,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            },
            "high": {
              "value": 99,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            }
          }
        ],
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "3151-8",
                  "display": "Inhaled oxygen flow rate"
                }
              ],
              "text": "Inhaled oxygen flow rate"
            },
            "valueQuantity": {
              "value": 6,
              "unit": "liters/min",
              "system": "http://unitsofmeasure.org",
              "code": "L/min"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Pulse Oximetry - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<59408-5>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=59408-5"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-f34fc728",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-16",
      "resource": {
        "resourceType": "Observation",
        "id": "example-16",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Observation satO2-fiO2</b></p><a name="satO2-fiO2"> </a><a name="hcsatO2-fiO2"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-pulse-oximetry.html">US Core Pulse Oximetry Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://example.org/FHIR/observation/identifiers</code>/o1223435-10</p><p><b>status</b>: Final</p><p><b>category</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/observation-category vital-signs}">Vital Signs</span></p><p><b>code</b>: <span title="Codes:{http://loinc.org 2708-6}, {http://loinc.org 59408-5}, {urn:iso:std:iso:11073:10101 150456}">Oxygen saturation in Arterial blood</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><p><b>effective</b>: 2014-12-05 09:30:10+0100</p><p><b>performer</b>: <a href="Practitioner-practitioner-1.html">Dr Ronald Bone</a></p><p><b>value</b>: 95 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></p><p><b>interpretation</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation N}">Normal</span></p><p><b>device</b>: Acme Pulse Oximeter 2000</p><h3>ReferenceRanges</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Low</b></td><td><b>High</b></td></tr><tr><td style="display: none">*</td><td>90 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td><td>99 %<span style="background: LightGoldenRodYellow"> (Details: UCUM  code% = '%')</span></td></tr></table><h3>Components</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:{http://loinc.org 3151-8}">Inhaled oxygen flow rate</span></td><td>6 liters/min<span style="background: LightGoldenRodYellow"> (Details: UCUM  codeL/min = 'L/min')</span></td></tr></table></div>"
        },
        "identifier": [
          {
            "system": "http://example.org/FHIR/observation/identifiers",
            "value": "o1223435-10"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "2708-6",
              "display": "Oxygen saturation in Arterial blood"
            },
            {
              "system": "http://loinc.org",
              "code": "59408-5",
              "display": "Oxygen saturation in Arterial blood by Pulse oximetry"
            },
            {
              "system": "urn:iso:std:iso:11073:10101",
              "code": "150456",
              "display": "MDC_PULS_OXIM_SAT_O2"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "2014-12-05T09:30:10+01:00",
        "performer": [
          {
            "reference": "Practitioner/practitioner-1",
            "display": "Dr Ronald Bone"
          }
        ],
        "valueQuantity": {
          "value": 95,
          "unit": "%",
          "system": "http://unitsofmeasure.org",
          "code": "%"
        },
        "interpretation": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "code": "N",
                "display": "Normal"
              }
            ],
            "text": "Normal"
          }
        ],
        "device": {
          "display": "Acme Pulse Oximeter 2000"
        },
        "referenceRange": [
          {
            "low": {
              "value": 90,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            },
            "high": {
              "value": 99,
              "unit": "%",
              "system": "http://unitsofmeasure.org",
              "code": "%"
            }
          }
        ],
        "component": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://loinc.org",
                  "code": "3151-8",
                  "display": "Inhaled oxygen flow rate"
                }
              ],
              "text": "Inhaled oxygen flow rate"
            },
            "valueQuantity": {
              "value": 6,
              "unit": "liters/min",
              "system": "http://unitsofmeasure.org",
              "code": "L/min"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Respiratory Rate) Resource Endpoints

Conforms to the US Core Respiratory Rate Profile (LOINC 9279-1).

GET Observation - Respiratory Rate - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/respiratory-rate
Parameters
idstring<respiratory-rate>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/respiratory-rate
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "respiratory-rate",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/StructureDefinition/vitalsigns"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: respiratory-rate</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Respiratory rate <span>(Details : {LOINC code '9279-1' = 'Respiratory rate', given as 'Respiratory rate'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 26 breaths/minute<span> (Details: UCUM code /min = '/min')</span></p></div>"
  },
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "vital-signs",
          "display": "Vital Signs"
        }
      ],
      "text": "Vital Signs"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "9279-1",
        "display": "Respiratory rate"
      }
    ],
    "text": "Respiratory rate"
  },
  "subject": {
    "reference": "Patient/example"
  },
  "effectiveDateTime": "1999-07-02",
  "valueQuantity": {
    "value": 26,
    "unit": "breaths/minute",
    "system": "http://unitsofmeasure.org",
    "code": "/min"
  }
}

GET Observation - Respiratory Rate - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9279-1
Parameters
patientreference<example>
categorytoken<vital-signs>
codetoken<9279-1>
datedate<gt2023-01-01>
Example RequestSearch Respiratory Rate
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9279-1"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-460a5d15",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&code=9279-1"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/respiratory-rate",
      "resource": {
        "resourceType": "Observation",
        "id": "respiratory-rate",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: respiratory-rate</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Respiratory rate <span>(Details : {LOINC code '9279-1' = 'Respiratory rate', given as 'Respiratory rate'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 26 breaths/minute<span> (Details: UCUM code /min = '/min')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "9279-1",
              "display": "Respiratory rate"
            }
          ],
          "text": "Respiratory rate"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 26,
          "unit": "breaths/minute",
          "system": "http://unitsofmeasure.org",
          "code": "/min"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Respiratory Rate - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
codetoken<9279-1>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "code=9279-1"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-9f40ec54",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/respiratory-rate",
      "resource": {
        "resourceType": "Observation",
        "id": "respiratory-rate",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/StructureDefinition/vitalsigns"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: respiratory-rate</p><p><b>meta</b>: </p><p><b>status</b>: final</p><p><b>category</b>: Vital Signs <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'vital-signs' = 'Vital Signs', given as 'Vital Signs'})</span></p><p><b>code</b>: Respiratory rate <span>(Details : {LOINC code '9279-1' = 'Respiratory rate', given as 'Respiratory rate'})</span></p><p><b>subject</b>: <a>Patient/example</a></p><p><b>effective</b>: 02/07/1999</p><p><b>value</b>: 26 breaths/minute<span> (Details: UCUM code /min = '/min')</span></p></div>"
        },
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "vital-signs",
                "display": "Vital Signs"
              }
            ],
            "text": "Vital Signs"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "9279-1",
              "display": "Respiratory rate"
            }
          ],
          "text": "Respiratory rate"
        },
        "subject": {
          "reference": "Patient/example"
        },
        "effectiveDateTime": "1999-07-02",
        "valueQuantity": {
          "value": 26,
          "unit": "breaths/minute",
          "system": "http://unitsofmeasure.org",
          "code": "/min"
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Observation (Screening & Assessment) Resource Endpoints

Conforms to the US Core Observation Screening Assessment Profile. Used to capture results of standardized assessment instruments (e.g., PRAPARE, AHC-HRSN).

GET Observation - Screening & Assessment - Read by ID

Retrieves a specific observation record by its logical ID. Requires patient/Observation.read or patient/Observation.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation/example-18
Parameters
idstring<example-18>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Observation/example-18
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Observation",
  "id": "example-18",
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/observation-category",
          "code": "survey",
          "display": "Survey"
        }
      ],
      "text": "Survey"
    },
    {
      "coding": [
        {
          "system": "http://open.epic.com/FHIR/StructureDefinition/observation-category",
          "code": "external-survey",
          "display": "External Survey"
        }
      ],
      "text": "External Survey"
    },
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
          "code": "sdoh",
          "display": "sdoh"
        }
      ],
      "text": "sdoh"
    },
    {
      "coding": [
        {
          "system": "urn:oid:1.2.840.114350.1.72.1.8.1",
          "code": "X-SDOH-DOMAIN-101",
          "display": "Postpartum Depression"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "71354-5",
        "display": "Edinburgh Postnatal Depression Scale [EPDS]"
      }
    ],
    "text": "Edinburgh Postnatal Depression Scale"
  },
  "subject": {
    "reference": "Patient/eHbAXIMc5gSWa6JczktbLLQ3",
    "display": "FHIR, Test Patient"
  },
  "effectiveDateTime": "2025-08-13T05:00:00Z",
  "interpretation": [
    {
      "text": "High Risk"
    }
  ],
  "hasMember": [
    {
      "reference": "Observation/fVmjf4bSEy0nzAeZC0ltn972xG2Ab8p2xUFif8QZOrdk4",
      "display": "Edinburgh Postnatal Depression Scale Total"
    },
    {
      "reference": "Observation/fBbndoMhT61cQ.4UA4VKo-P-9g9ilrmAXiD9nXMXAQwM4",
      "display": "The thought of harming myself has occurred to me."
    }
  ]
}

GET Observation - Screening & Assessment - Search by Parameter

Searches observation resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=survey
Parameters
patientreference<example>
categorytoken<survey>
codetoken<LOINC code>
datedate<gt2023-01-01>
Example RequestSearch Screening Results
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=survey"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-f9d6c641",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation?patient=example&category=survey"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-18",
      "resource": {
        "resourceType": "Observation",
        "id": "example-18",
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "survey",
                "display": "Survey"
              }
            ],
            "text": "Survey"
          },
          {
            "coding": [
              {
                "system": "http://open.epic.com/FHIR/StructureDefinition/observation-category",
                "code": "external-survey",
                "display": "External Survey"
              }
            ],
            "text": "External Survey"
          },
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
                "code": "sdoh",
                "display": "sdoh"
              }
            ],
            "text": "sdoh"
          },
          {
            "coding": [
              {
                "system": "urn:oid:1.2.840.114350.1.72.1.8.1",
                "code": "X-SDOH-DOMAIN-101",
                "display": "Postpartum Depression"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "71354-5",
              "display": "Edinburgh Postnatal Depression Scale [EPDS]"
            }
          ],
          "text": "Edinburgh Postnatal Depression Scale"
        },
        "subject": {
          "reference": "Patient/eHbAXIMc5gSWa6JczktbLLQ3",
          "display": "FHIR, Test Patient"
        },
        "effectiveDateTime": "2025-08-13T05:00:00Z",
        "interpretation": [
          {
            "text": "High Risk"
          }
        ],
        "hasMember": [
          {
            "reference": "Observation/fVmjf4bSEy0nzAeZC0ltn972xG2Ab8p2xUFif8QZOrdk4",
            "display": "Edinburgh Postnatal Depression Scale Total"
          },
          {
            "reference": "Observation/fBbndoMhT61cQ.4UA4VKo-P-9g9ilrmAXiD9nXMXAQwM4",
            "display": "The thought of harming myself has occurred to me."
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Observation - Screening & Assessment - Search by Parameter

Searches observation resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Observation/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
categorytoken<survey>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "category=survey"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-17ec6ee2",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Observation/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Observation/example-18",
      "resource": {
        "resourceType": "Observation",
        "id": "example-18",
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "survey",
                "display": "Survey"
              }
            ],
            "text": "Survey"
          },
          {
            "coding": [
              {
                "system": "http://open.epic.com/FHIR/StructureDefinition/observation-category",
                "code": "external-survey",
                "display": "External Survey"
              }
            ],
            "text": "External Survey"
          },
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-category",
                "code": "sdoh",
                "display": "sdoh"
              }
            ],
            "text": "sdoh"
          },
          {
            "coding": [
              {
                "system": "urn:oid:1.2.840.114350.1.72.1.8.1",
                "code": "X-SDOH-DOMAIN-101",
                "display": "Postpartum Depression"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "71354-5",
              "display": "Edinburgh Postnatal Depression Scale [EPDS]"
            }
          ],
          "text": "Edinburgh Postnatal Depression Scale"
        },
        "subject": {
          "reference": "Patient/eHbAXIMc5gSWa6JczktbLLQ3",
          "display": "FHIR, Test Patient"
        },
        "effectiveDateTime": "2025-08-13T05:00:00Z",
        "interpretation": [
          {
            "text": "High Risk"
          }
        ],
        "hasMember": [
          {
            "reference": "Observation/fVmjf4bSEy0nzAeZC0ltn972xG2Ab8p2xUFif8QZOrdk4",
            "display": "Edinburgh Postnatal Depression Scale Total"
          },
          {
            "reference": "Observation/fBbndoMhT61cQ.4UA4VKo-P-9g9ilrmAXiD9nXMXAQwM4",
            "display": "The thought of harming myself has occurred to me."
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Organization Resource Endpoints

Conforms to the US Core Organization Profile, describing payers, providers, labs, and other corporate entities.

GET Organization - Read by ID

Retrieves a specific organization record by its logical ID. Requires patient/Organization.read or patient/Organization.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Organization/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Organization/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Organization",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
    ]
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "1407071236"
    }
  ],
  "active": true,
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-type",
          "code": "prov",
          "display": "Healthcare Provider"
        }
      ]
    }
  ],
  "name": "NexaPoint Health",
  "telecom": [
    {
      "system": "phone",
      "value": "+1-918-555-0100",
      "use": "work"
    }
  ],
  "address": [
    {
      "line": [
        "1500 S Lewis Ave"
      ],
      "city": "Tulsa",
      "state": "OK",
      "postalCode": "74104",
      "country": "US"
    }
  ]
}

GET Organization - Search by Parameter

Searches organization resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Organization?name=NexaPoint
Parameters
namestring<NexaPoint>
addressstring<Tulsa>
Example RequestSearch by Name
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Organization?name=NexaPoint"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b6dc10b1",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Organization?name=NexaPoint"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Organization/example",
      "resource": {
        "resourceType": "Organization",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "1407071236"
          }
        ],
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                "code": "prov",
                "display": "Healthcare Provider"
              }
            ]
          }
        ],
        "name": "NexaPoint Health",
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0100",
            "use": "work"
          }
        ],
        "address": [
          {
            "line": [
              "1500 S Lewis Ave"
            ],
            "city": "Tulsa",
            "state": "OK",
            "postalCode": "74104",
            "country": "US"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Organization - Search by Parameter

Searches organization resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Organization/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
namestring<NexaPoint>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Organization/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "name=NexaPoint"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-4e55adde",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Organization/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Organization/example",
      "resource": {
        "resourceType": "Organization",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "1407071236"
          }
        ],
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                "code": "prov",
                "display": "Healthcare Provider"
              }
            ]
          }
        ],
        "name": "NexaPoint Health",
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0100",
            "use": "work"
          }
        ],
        "address": [
          {
            "line": [
              "1500 S Lewis Ave"
            ],
            "city": "Tulsa",
            "state": "OK",
            "postalCode": "74104",
            "country": "US"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Practitioner Resource Endpoints

Conforms to the US Core Practitioner Profile, describing clinicians and other individual providers identified by NPI.

GET Practitioner - Read by ID

Retrieves a specific practitioner record by its logical ID. Requires patient/Practitioner.read or patient/Practitioner.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Practitioner/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Practitioner/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Practitioner",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
    ]
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "9941339108"
    }
  ],
  "active": true,
  "name": [
    {
      "family": "Bone",
      "given": [
        "Ronald"
      ],
      "prefix": [
        "Dr."
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+1-918-555-0145",
      "use": "work"
    },
    {
      "system": "email",
      "value": "r.bone@nexapointhealth.com"
    }
  ],
  "address": [
    {
      "use": "work",
      "line": [
        "1500 S Lewis Ave"
      ],
      "city": "Tulsa",
      "state": "OK",
      "postalCode": "74104",
      "country": "US"
    }
  ],
  "qualification": [
    {
      "code": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
            "code": "MD",
            "display": "Doctor of Medicine"
          }
        ],
        "text": "MD"
      },
      "issuer": {
        "display": "Oklahoma State Medical Board"
      }
    }
  ]
}

GET Practitioner - Search by Parameter

Searches practitioner resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Practitioner?name=Bone
Parameters
namestring<Bone>
identifiertoken<NPI>
Example RequestSearch by Name
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Practitioner?name=Bone"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-ab5f0d4a",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Practitioner?name=Bone"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Practitioner/example",
      "resource": {
        "resourceType": "Practitioner",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "9941339108"
          }
        ],
        "active": true,
        "name": [
          {
            "family": "Bone",
            "given": [
              "Ronald"
            ],
            "prefix": [
              "Dr."
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0145",
            "use": "work"
          },
          {
            "system": "email",
            "value": "r.bone@nexapointhealth.com"
          }
        ],
        "address": [
          {
            "use": "work",
            "line": [
              "1500 S Lewis Ave"
            ],
            "city": "Tulsa",
            "state": "OK",
            "postalCode": "74104",
            "country": "US"
          }
        ],
        "qualification": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                  "code": "MD",
                  "display": "Doctor of Medicine"
                }
              ],
              "text": "MD"
            },
            "issuer": {
              "display": "Oklahoma State Medical Board"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Practitioner - Search by Parameter

Searches practitioner resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Practitioner/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
namestring<Bone>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Practitioner/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "name=Bone"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b66cdb78",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Practitioner/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Practitioner/example",
      "resource": {
        "resourceType": "Practitioner",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "9941339108"
          }
        ],
        "active": true,
        "name": [
          {
            "family": "Bone",
            "given": [
              "Ronald"
            ],
            "prefix": [
              "Dr."
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0145",
            "use": "work"
          },
          {
            "system": "email",
            "value": "r.bone@nexapointhealth.com"
          }
        ],
        "address": [
          {
            "use": "work",
            "line": [
              "1500 S Lewis Ave"
            ],
            "city": "Tulsa",
            "state": "OK",
            "postalCode": "74104",
            "country": "US"
          }
        ],
        "qualification": [
          {
            "code": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                  "code": "MD",
                  "display": "Doctor of Medicine"
                }
              ],
              "text": "MD"
            },
            "issuer": {
              "display": "Oklahoma State Medical Board"
            }
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

PractitionerRole Resource Endpoints

Conforms to the US Core PractitionerRole Profile, linking a Practitioner to an Organization, Location, and specialty.

GET PractitionerRole - Read by ID

Retrieves a specific practitionerrole record by its logical ID. Requires patient/PractitionerRole.read or patient/PractitionerRole.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "PractitionerRole",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
    ]
  },
  "active": true,
  "practitioner": {
    "reference": "Practitioner/example",
    "display": "Dr. Ronald Bone"
  },
  "organization": {
    "reference": "Organization/example",
    "display": "NexaPoint Health"
  },
  "code": [
    {
      "coding": [
        {
          "system": "http://nucc.org/provider-taxonomy",
          "code": "207RE0101X",
          "display": "Endocrinology"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://nucc.org/provider-taxonomy",
          "code": "207RE0101X",
          "display": "Endocrinology, Diabetes & Metabolism"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "Location/example",
      "display": "NexaPoint Family Clinic - Tulsa"
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+1-918-555-0145",
      "use": "work"
    }
  ],
  "availableTime": [
    {
      "daysOfWeek": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "availableStartTime": "08:00:00",
      "availableEndTime": "17:00:00"
    }
  ]
}

GET PractitionerRole - Search by Parameter

Searches practitionerrole resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/PractitionerRole?practitioner=example
Parameters
practitionerreference<example>
specialtytoken<NUCC code>
Example RequestSearch by Practitioner
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole?practitioner=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-53986c9d",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole?practitioner=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/example",
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
          ]
        },
        "active": true,
        "practitioner": {
          "reference": "Practitioner/example",
          "display": "Dr. Ronald Bone"
        },
        "organization": {
          "reference": "Organization/example",
          "display": "NexaPoint Health"
        },
        "code": [
          {
            "coding": [
              {
                "system": "http://nucc.org/provider-taxonomy",
                "code": "207RE0101X",
                "display": "Endocrinology"
              }
            ]
          }
        ],
        "specialty": [
          {
            "coding": [
              {
                "system": "http://nucc.org/provider-taxonomy",
                "code": "207RE0101X",
                "display": "Endocrinology, Diabetes & Metabolism"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "Location/example",
            "display": "NexaPoint Family Clinic - Tulsa"
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0145",
            "use": "work"
          }
        ],
        "availableTime": [
          {
            "daysOfWeek": [
              "mon",
              "tue",
              "wed",
              "thu",
              "fri"
            ],
            "availableStartTime": "08:00:00",
            "availableEndTime": "17:00:00"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST PractitionerRole - Search by Parameter

Searches practitionerrole resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
practitionerreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "practitioner=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-d7556e65",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/PractitionerRole/example",
      "resource": {
        "resourceType": "PractitionerRole",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
          ]
        },
        "active": true,
        "practitioner": {
          "reference": "Practitioner/example",
          "display": "Dr. Ronald Bone"
        },
        "organization": {
          "reference": "Organization/example",
          "display": "NexaPoint Health"
        },
        "code": [
          {
            "coding": [
              {
                "system": "http://nucc.org/provider-taxonomy",
                "code": "207RE0101X",
                "display": "Endocrinology"
              }
            ]
          }
        ],
        "specialty": [
          {
            "coding": [
              {
                "system": "http://nucc.org/provider-taxonomy",
                "code": "207RE0101X",
                "display": "Endocrinology, Diabetes & Metabolism"
              }
            ]
          }
        ],
        "location": [
          {
            "reference": "Location/example",
            "display": "NexaPoint Family Clinic - Tulsa"
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+1-918-555-0145",
            "use": "work"
          }
        ],
        "availableTime": [
          {
            "daysOfWeek": [
              "mon",
              "tue",
              "wed",
              "thu",
              "fri"
            ],
            "availableStartTime": "08:00:00",
            "availableEndTime": "17:00:00"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Procedure Resource Endpoints

Conforms to the US Core Procedure Profile, returning surgical, diagnostic, and therapeutic procedures performed for the patient.

GET Procedure - Read by ID

Retrieves a specific procedure record by its logical ID. Requires patient/Procedure.read or patient/Procedure.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Procedure/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Procedure/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Procedure",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
    ]
  },
  "status": "completed",
  "category": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "387713003",
        "display": "Surgical procedure"
      }
    ]
  },
  "code": {
    "coding": [
      {
        "system": "http://www.ama-assn.org/go/cpt",
        "code": "45378",
        "display": "Colonoscopy, flexible; diagnostic"
      },
      {
        "system": "http://snomed.info/sct",
        "code": "73761001",
        "display": "Colonoscopy"
      }
    ],
    "text": "Screening colonoscopy"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "performedDateTime": "2024-02-08T09:00:00-05:00",
  "performer": [
    {
      "actor": {
        "reference": "Practitioner/practitioner-1",
        "display": "Dr. Ronald Bone"
      },
      "function": {
        "text": "Primary surgeon"
      }
    }
  ],
  "location": {
    "reference": "Location/example",
    "display": "NexaPoint Family Clinic - Tulsa"
  },
  "reasonCode": [
    {
      "text": "Routine cancer screening"
    }
  ]
}

GET Procedure - Search by Parameter

Searches procedure resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Procedure?patient=example&status=completed
Parameters
patientreference<example>
statustoken<completed|in-progress|not-done>
datedate<gt2023-01-01>
Example RequestSearch Completed Procedures
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Procedure?patient=example&status=completed"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-e1bad8ca",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Procedure?patient=example&status=completed"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Procedure/example",
      "resource": {
        "resourceType": "Procedure",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
          ]
        },
        "status": "completed",
        "category": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "387713003",
              "display": "Surgical procedure"
            }
          ]
        },
        "code": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "45378",
              "display": "Colonoscopy, flexible; diagnostic"
            },
            {
              "system": "http://snomed.info/sct",
              "code": "73761001",
              "display": "Colonoscopy"
            }
          ],
          "text": "Screening colonoscopy"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "performedDateTime": "2024-02-08T09:00:00-05:00",
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            },
            "function": {
              "text": "Primary surgeon"
            }
          }
        ],
        "location": {
          "reference": "Location/example",
          "display": "NexaPoint Family Clinic - Tulsa"
        },
        "reasonCode": [
          {
            "text": "Routine cancer screening"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Procedure - Search by Parameter

Searches procedure resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Procedure/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
statustoken<completed>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Procedure/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "status=completed"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-cf70bdf3",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Procedure/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Procedure/example",
      "resource": {
        "resourceType": "Procedure",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
          ]
        },
        "status": "completed",
        "category": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "387713003",
              "display": "Surgical procedure"
            }
          ]
        },
        "code": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "45378",
              "display": "Colonoscopy, flexible; diagnostic"
            },
            {
              "system": "http://snomed.info/sct",
              "code": "73761001",
              "display": "Colonoscopy"
            }
          ],
          "text": "Screening colonoscopy"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "performedDateTime": "2024-02-08T09:00:00-05:00",
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            },
            "function": {
              "text": "Primary surgeon"
            }
          }
        ],
        "location": {
          "reference": "Location/example",
          "display": "NexaPoint Family Clinic - Tulsa"
        },
        "reasonCode": [
          {
            "text": "Routine cancer screening"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Provenance Resource Endpoints

Conforms to the US Core Provenance Profile, recording the agents and activities responsible for producing a target resource.

GET Provenance - Read by ID

Retrieves a specific provenance record by its logical ID. Requires patient/Provenance.read or patient/Provenance.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Provenance/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Provenance/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Provenance",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
    ]
  },
  "target": [
    {
      "reference": "Condition/condition-SDOH-example"
    }
  ],
  "recorded": "2024-02-08T14:15:00-05:00",
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
            "code": "author",
            "display": "Author"
          }
        ]
      },
      "who": {
        "reference": "Practitioner/practitioner-1",
        "display": "Dr. Ronald Bone"
      },
      "onBehalfOf": {
        "reference": "Organization/example",
        "display": "NexaPoint Health"
      }
    },
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
            "code": "transmitter",
            "display": "Transmitter"
          }
        ]
      },
      "who": {
        "reference": "Organization/example",
        "display": "NexaPoint Health"
      }
    }
  ],
  "activity": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
        "code": "CREATE",
        "display": "create"
      }
    ]
  }
}

GET Provenance - Search by Parameter

Searches provenance resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Provenance?target=Condition/condition-SDOH-example
Parameters
targetreference<Condition/condition-SDOH-example>
Example RequestSearch by Target
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Provenance?target=Condition/condition-SDOH-example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-19b0b66e",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Provenance?target=Condition/condition-SDOH-example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Provenance/example",
      "resource": {
        "resourceType": "Provenance",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
          ]
        },
        "target": [
          {
            "reference": "Condition/condition-SDOH-example"
          }
        ],
        "recorded": "2024-02-08T14:15:00-05:00",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author",
                  "display": "Author"
                }
              ]
            },
            "who": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            },
            "onBehalfOf": {
              "reference": "Organization/example",
              "display": "NexaPoint Health"
            }
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "transmitter",
                  "display": "Transmitter"
                }
              ]
            },
            "who": {
              "reference": "Organization/example",
              "display": "NexaPoint Health"
            }
          }
        ],
        "activity": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
              "code": "CREATE",
              "display": "create"
            }
          ]
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Provenance - Search by Parameter

Searches provenance resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Provenance/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
targetreference<Condition/condition-SDOH-example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Provenance/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "target=Condition/condition-SDOH-example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b66e1cc1",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Provenance/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Provenance/example",
      "resource": {
        "resourceType": "Provenance",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
          ]
        },
        "target": [
          {
            "reference": "Condition/condition-SDOH-example"
          }
        ],
        "recorded": "2024-02-08T14:15:00-05:00",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author",
                  "display": "Author"
                }
              ]
            },
            "who": {
              "reference": "Practitioner/practitioner-1",
              "display": "Dr. Ronald Bone"
            },
            "onBehalfOf": {
              "reference": "Organization/example",
              "display": "NexaPoint Health"
            }
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "transmitter",
                  "display": "Transmitter"
                }
              ]
            },
            "who": {
              "reference": "Organization/example",
              "display": "NexaPoint Health"
            }
          }
        ],
        "activity": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-DataOperation",
              "code": "CREATE",
              "display": "create"
            }
          ]
        }
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

RelatedPerson Resource Endpoints

Conforms to the US Core RelatedPerson Profile, describing family members, guardians, and other persons related to the patient.

GET RelatedPerson - Read by ID

Retrieves a specific relatedperson record by its logical ID. Requires patient/RelatedPerson.read or patient/RelatedPerson.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/example-1
Parameters
idstring<example-1>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/example-1
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "RelatedPerson",
  "id": "example-1",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: RelatedPerson shaw-niece</b></p><a name="shaw-niece"> </a><a name="hcshaw-niece"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-relatedperson.html">US Core RelatedPerson Profileversion: null8.0.1)</a></p></div><p><b>active</b>: true</p><p><b>patient</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NIECE}">niece</span></p><p><b>name</b>: Sarah van Putten (Official)</p><p><b>telecom</b>: ph: 555-555-5555(Home), <a href="mailto:sarah.vanputten@example.com">sarah.vanputten@example.com</a></p><p><b>birthDate</b>: 1996-01-28</p><p><b>address</b>: 80A VILLAGE ST NEW HOLLAND PA 17557 (home)</p></div>"
  },
  "active": true,
  "patient": {
    "reference": "Patient/example",
    "display": "Amy V. Shaw"
  },
  "relationship": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "NIECE",
          "display": "niece"
        }
      ]
    }
  ],
  "name": [
    {
      "use": "official",
      "family": "van Putten",
      "given": [
        "Sarah"
      ]
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "555-555-5555",
      "use": "home"
    },
    {
      "system": "email",
      "value": "sarah.vanputten@example.com",
      "use": "home"
    }
  ],
  "birthDate": "1996-01-28",
  "address": [
    {
      "use": "home",
      "line": [
        "80A VILLAGE ST"
      ],
      "city": "NEW HOLLAND",
      "state": "PA",
      "postalCode": "17557"
    }
  ]
}

GET RelatedPerson - Search by Parameter

Searches relatedperson resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/RelatedPerson?patient=example
Parameters
patientreference<example>
namestring<Smith>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-61605d9d",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/example-1",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "example-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: RelatedPerson shaw-niece</b></p><a name="shaw-niece"> </a><a name="hcshaw-niece"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-relatedperson.html">US Core RelatedPerson Profileversion: null8.0.1)</a></p></div><p><b>active</b>: true</p><p><b>patient</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NIECE}">niece</span></p><p><b>name</b>: Sarah van Putten (Official)</p><p><b>telecom</b>: ph: 555-555-5555(Home), <a href="mailto:sarah.vanputten@example.com">sarah.vanputten@example.com</a></p><p><b>birthDate</b>: 1996-01-28</p><p><b>address</b>: 80A VILLAGE ST NEW HOLLAND PA 17557 (home)</p></div>"
        },
        "active": true,
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Shaw"
        },
        "relationship": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "NIECE",
                "display": "niece"
              }
            ]
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "van Putten",
            "given": [
              "Sarah"
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-555-5555",
            "use": "home"
          },
          {
            "system": "email",
            "value": "sarah.vanputten@example.com",
            "use": "home"
          }
        ],
        "birthDate": "1996-01-28",
        "address": [
          {
            "use": "home",
            "line": [
              "80A VILLAGE ST"
            ],
            "city": "NEW HOLLAND",
            "state": "PA",
            "postalCode": "17557"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST RelatedPerson - Search by Parameter

Searches relatedperson resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-678b4d61",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/RelatedPerson/example-1",
      "resource": {
        "resourceType": "RelatedPerson",
        "id": "example-1",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: RelatedPerson shaw-niece</b></p><a name="shaw-niece"> </a><a name="hcshaw-niece"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-relatedperson.html">US Core RelatedPerson Profileversion: null8.0.1)</a></p></div><p><b>active</b>: true</p><p><b>patient</b>: <a href="Patient-example.html">Amy V. Shaw</a></p><p><b>relationship</b>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleCode NIECE}">niece</span></p><p><b>name</b>: Sarah van Putten (Official)</p><p><b>telecom</b>: ph: 555-555-5555(Home), <a href="mailto:sarah.vanputten@example.com">sarah.vanputten@example.com</a></p><p><b>birthDate</b>: 1996-01-28</p><p><b>address</b>: 80A VILLAGE ST NEW HOLLAND PA 17557 (home)</p></div>"
        },
        "active": true,
        "patient": {
          "reference": "Patient/example",
          "display": "Amy V. Shaw"
        },
        "relationship": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "NIECE",
                "display": "niece"
              }
            ]
          }
        ],
        "name": [
          {
            "use": "official",
            "family": "van Putten",
            "given": [
              "Sarah"
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "555-555-5555",
            "use": "home"
          },
          {
            "system": "email",
            "value": "sarah.vanputten@example.com",
            "use": "home"
          }
        ],
        "birthDate": "1996-01-28",
        "address": [
          {
            "use": "home",
            "line": [
              "80A VILLAGE ST"
            ],
            "city": "NEW HOLLAND",
            "state": "PA",
            "postalCode": "17557"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

ServiceRequest Resource Endpoints

Conforms to the US Core ServiceRequest Profile, capturing referrals and orders for diagnostic and therapeutic services.

GET ServiceRequest - Read by ID

Retrieves a specific servicerequest record by its logical ID. Requires patient/ServiceRequest.read or patient/ServiceRequest.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/example
Parameters
idstring<example>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/example
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "ServiceRequest",
  "id": "example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "108252007",
          "display": "Laboratory procedure"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "58410-2",
        "display": "Complete blood count (hemogram) panel - Blood by Automated count"
      }
    ],
    "text": "CBC w/ Differential"
  },
  "subject": {
    "reference": "Patient/example",
    "display": "Amy V. Baxter"
  },
  "encounter": {
    "reference": "Encounter/example"
  },
  "authoredOn": "2024-02-08T14:30:00-05:00",
  "requester": {
    "reference": "Practitioner/practitioner-1",
    "display": "Dr. Ronald Bone"
  },
  "performer": [
    {
      "reference": "Organization/acme-lab",
      "display": "Acme Reference Lab"
    }
  ],
  "reasonCode": [
    {
      "text": "Fatigue, evaluate for anemia"
    }
  ]
}

GET ServiceRequest - Search by Parameter

Searches servicerequest resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/ServiceRequest?patient=example&status=active
Parameters
patientreference<example>
statustoken<active|completed|revoked>
categorytoken<SNOMED code>
codetoken<LOINC / SNOMED code>
intenttoken<order|plan>
authoreddate<gt2024-01-01>
Example RequestSearch Active Orders
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest?patient=example&status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-b24cd969",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest?patient=example&status=active"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/example",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"
          ]
        },
        "status": "active",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "108252007",
                "display": "Laboratory procedure"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "58410-2",
              "display": "Complete blood count (hemogram) panel - Blood by Automated count"
            }
          ],
          "text": "CBC w/ Differential"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "authoredOn": "2024-02-08T14:30:00-05:00",
        "requester": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "performer": [
          {
            "reference": "Organization/acme-lab",
            "display": "Acme Reference Lab"
          }
        ],
        "reasonCode": [
          {
            "text": "Fatigue, evaluate for anemia"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST ServiceRequest - Search by Parameter

Searches servicerequest resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
statustoken<active>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example" \
  --data-urlencode "status=active"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-687cf97b",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/ServiceRequest/example",
      "resource": {
        "resourceType": "ServiceRequest",
        "id": "example",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-servicerequest"
          ]
        },
        "status": "active",
        "intent": "order",
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "108252007",
                "display": "Laboratory procedure"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "58410-2",
              "display": "Complete blood count (hemogram) panel - Blood by Automated count"
            }
          ],
          "text": "CBC w/ Differential"
        },
        "subject": {
          "reference": "Patient/example",
          "display": "Amy V. Baxter"
        },
        "encounter": {
          "reference": "Encounter/example"
        },
        "authoredOn": "2024-02-08T14:30:00-05:00",
        "requester": {
          "reference": "Practitioner/practitioner-1",
          "display": "Dr. Ronald Bone"
        },
        "performer": [
          {
            "reference": "Organization/acme-lab",
            "display": "Acme Reference Lab"
          }
        ],
        "reasonCode": [
          {
            "text": "Fatigue, evaluate for anemia"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Specimen Resource Endpoints

Conforms to the US Core Specimen Profile, describing biological specimens collected for laboratory analysis.

GET Specimen - Read by ID

Retrieves a specific specimen record by its logical ID. Requires patient/Specimen.read or patient/Specimen.rs scope.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Specimen/example-serum-lipemic
Parameters
idstring<example-serum-lipemic>
Example RequestRead by ID
curl
curl --location https://fhir.nexapointhealth.com/fhir/r4/Specimen/example-serum-lipemic
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Specimen",
  "id": "example-serum-lipemic",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|8.0.1"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Specimen example-serum-lipemic</b></p><a name="example-serum-lipemic"> </a><a name="hcexample-serum-lipemic"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-specimen.html">US Core Specimen Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>accessionIdentifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>type</b>: <span title="Codes:{http://snomed.info/sct 119364003}, {http://terminology.hl7.org/CodeSystem/v2-0487 SER}">Serum sample</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><h3>Containers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:">Serum Separator Tube</span></td></tr></table><p><b>condition</b>: <span title="Codes:{http://snomed.info/sct 118127007}">Lipemic</span></p></div>"
  },
  "identifier": [
    {
      "system": "http://acme.com/labs/accession-ids",
      "value": "20241105-00124"
    }
  ],
  "accessionIdentifier": {
    "system": "http://acme.com/labs/accession-ids",
    "value": "20241105-00124"
  },
  "type": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "version": "http://snomed.info/sct/731000124108",
        "code": "119364003",
        "display": "Serum sample"
      },
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0487",
        "code": "SER",
        "display": "Serum"
      }
    ]
  },
  "subject": {
    "reference": "Patient/example"
  },
  "container": [
    {
      "type": {
        "text": "Serum Separator Tube"
      }
    }
  ],
  "condition": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "118127007",
          "display": "Specimen lipemic"
        }
      ],
      "text": "Lipemic"
    }
  ]
}

GET Specimen - Search by Parameter

Searches specimen resources by patient and additional filters. Multiple filters are evaluated with logical AND.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

GEThttps://fhir.nexapointhealth.com/fhir/r4/Specimen?patient=example
Parameters
patientreference<example>
Example RequestSearch by Patient
curl
curl --location "https://fhir.nexapointhealth.com/fhir/r4/Specimen?patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-67049b7a",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Specimen?patient=example"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Specimen/example-serum-lipemic",
      "resource": {
        "resourceType": "Specimen",
        "id": "example-serum-lipemic",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Specimen example-serum-lipemic</b></p><a name="example-serum-lipemic"> </a><a name="hcexample-serum-lipemic"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-specimen.html">US Core Specimen Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>accessionIdentifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>type</b>: <span title="Codes:{http://snomed.info/sct 119364003}, {http://terminology.hl7.org/CodeSystem/v2-0487 SER}">Serum sample</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><h3>Containers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:">Serum Separator Tube</span></td></tr></table><p><b>condition</b>: <span title="Codes:{http://snomed.info/sct 118127007}">Lipemic</span></p></div>"
        },
        "identifier": [
          {
            "system": "http://acme.com/labs/accession-ids",
            "value": "20241105-00124"
          }
        ],
        "accessionIdentifier": {
          "system": "http://acme.com/labs/accession-ids",
          "value": "20241105-00124"
        },
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "119364003",
              "display": "Serum sample"
            },
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0487",
              "code": "SER",
              "display": "Serum"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "container": [
          {
            "type": {
              "text": "Serum Separator Tube"
            }
          }
        ],
        "condition": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "118127007",
                "display": "Specimen lipemic"
              }
            ],
            "text": "Lipemic"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

POST Specimen - Search by Parameter

Searches specimen resources with parameters passed in a URL-encoded POST body. Useful for complex queries or avoiding identifier logging.

Authorization OAuth 2.0 (under TLS 1.2)

Requires active Bearer token with patient isolation context.

POSThttps://fhir.nexapointhealth.com/fhir/r4/Specimen/_search
Headers
Content-Typestring<application/x-www-form-urlencoded>
Body Parameters
patientreference<example>
Example RequestPOST Search
curl
curl --location --request POST "https://fhir.nexapointhealth.com/fhir/r4/Specimen/_search" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "patient=example"
Example Response200 OK
Body
Headers (5)
json
{
  "resourceType": "Bundle",
  "id": "searchset-1c394e26",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/Specimen/_search"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir.nexapointhealth.com/fhir/r4/Specimen/example-serum-lipemic",
      "resource": {
        "resourceType": "Specimen",
        "id": "example-serum-lipemic",
        "meta": {
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen|8.0.1"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Specimen example-serum-lipemic</b></p><a name="example-serum-lipemic"> </a><a name="hcexample-serum-lipemic"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-us-core-specimen.html">US Core Specimen Profileversion: null8.0.1)</a></p></div><p><b>identifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>accessionIdentifier</b>: <code>http://acme.com/labs/accession-ids</code>/20241105-00124</p><p><b>type</b>: <span title="Codes:{http://snomed.info/sct 119364003}, {http://terminology.hl7.org/CodeSystem/v2-0487 SER}">Serum sample</span></p><p><b>subject</b>: <a href="Patient-example.html">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number: 1032702 (use: usual, ))</a></p><h3>Containers</h3><table class="grid"><tr><td style="display: none">-</td><td><b>Type</b></td></tr><tr><td style="display: none">*</td><td><span title="Codes:">Serum Separator Tube</span></td></tr></table><p><b>condition</b>: <span title="Codes:{http://snomed.info/sct 118127007}">Lipemic</span></p></div>"
        },
        "identifier": [
          {
            "system": "http://acme.com/labs/accession-ids",
            "value": "20241105-00124"
          }
        ],
        "accessionIdentifier": {
          "system": "http://acme.com/labs/accession-ids",
          "value": "20241105-00124"
        },
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "version": "http://snomed.info/sct/731000124108",
              "code": "119364003",
              "display": "Serum sample"
            },
            {
              "system": "http://terminology.hl7.org/CodeSystem/v2-0487",
              "code": "SER",
              "display": "Serum"
            }
          ]
        },
        "subject": {
          "reference": "Patient/example"
        },
        "container": [
          {
            "type": {
              "text": "Serum Separator Tube"
            }
          }
        ],
        "condition": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "118127007",
                "display": "Specimen lipemic"
              }
            ],
            "text": "Lipemic"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

FHIR Bulk Data Export ($export) v2.0

The facade implements asynchronous, system-wide and group-level exports compliant with the HL7 FHIR Bulk Data Access v2.0 specification. Developers kick off a job, poll for status, and download final resources written in NDJSON format.

Kickoff Request: Client issues a GET request with required headers: Prefer: respond-async and Accept: application/fhir+json.
Status Check Redirect: Server responds with an immediate 202 Accepted status and returns a status-tracking URL in the Content-Location response header.
Asynchronous Processing & Polling: Client polls the status URL. While building, the server returns 202 Accepted with a X-Progress status header.
Manifest Resolution: Once completed, the server responds with a `200 OK` status and a JSON manifest containing secure output download links for each resource type.

1. Initiate Bulk Export

You can execute a system-wide, patient-wide, or group-level export:

GET /fhir/r4/$export

System-level export (all patient resource records).

GET /fhir/r4/Group/:id/$export

Group-level export (restricts output to member patients in a specific group).

# HTTP Kickoff Request
GET /fhir/r4/Group/group-1/$export?_type=Patient,Observation HTTP/1.1
Host: fhir.nexapointhealth.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI...
Prefer: respond-async
Accept: application/fhir+json

2. Status Polling & Progress Tracking

Request the status tracking URL to monitor progress. Note that access tokens are strictly required for security validation:

GET /fhir/r4/$export/status/job-123xyz HTTP/1.1
Host: fhir.nexapointhealth.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI...

If the job is still actively exporting, the server responds with status code 202 Accepted:

HTTP/1.1 202 Accepted
X-Progress: Building... (12s elapsed)
Retry-After: 2

3. Retrieval Manifest Output

Once export files are built, polling the status endpoint resolves to a standard manifest with `200 OK` status:

Bulk Export Complete Manifest{
  "transactionTime": "2026-05-18T22:30:00.000Z",
  "request": "https://fhir.nexapointhealth.com/fhir/r4/Group/group-1/$export",
  "requiresAccessToken": true,
  "output": [
    {
      "type": "Patient",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/$export/files/patient_1.ndjson?jobId=job-123xyz",
      "count": 150
    },
    {
      "type": "Observation",
      "url": "https://fhir.nexapointhealth.com/fhir/r4/$export/files/observation_1.ndjson?jobId=job-123xyz",
      "count": 1200
    }
  ],
  "error": [],
  "deleted": []
}

Error Handling & OperationOutcome

The NXPH FHIR Facade converts all application and system exceptions into standard, structured FHIR `OperationOutcome` resources. This includes authentication challenges, security blockages, missing search criteria, or DB connectivity errors. Non-compliant, raw JSON or HTML payloads are never returned to clinical clients.

OperationOutcome Error Payload{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "diagnostics": "Access denied: Insufficient scope or patient context validation mismatch."
    }
  ]
}

HTTP Status Resolution Table

Use this reference table to map standard HTTP status codes returned by the facade to standard troubleshooting remedies:

HTTP Status Standard Code Facade Trigger & Remedy
400 Bad Request invalid Invalid search parameters, or missing required headers like Prefer: respond-async during kickoff.
401 Unauthorized login Missing or expired Bearer token, or invalid JWT signature. Re-execute authentication flow.
403 Forbidden forbidden Token is valid but is missing the required scopes (e.g. trying to write observations without write permissions).
404 Not Found not-found Target patient or clinical record resource identifier does not exist.
429 Too Many Requests throttled API rate limiter triggered due to excessive request velocity. Slow down queries.
502 Bad Gateway exception Temporary reverse proxy failure or Keycloak server is offline. Check status and try again.

ONC Mandated Terms of Service (ToS)

Welcome to the NXPH FHIR Facade API. These Terms of Service ("Terms") outline the legal obligations and requirements governing the access and use of the standard API endpoints provided by Nexapoint Health LLC ("Nexapoint", "we", "us", "our").

1. Access and Registration

Third-party application developers ("Developers", "you") must register their application profiles in the developer portal to receive client credentials. You are solely responsible for securing your client secrets and private key assertions. Mismatched or leaked credentials will result in immediate service suspension.

2. Patient Privacy and HIPAA Compliance

Developers must ensure that all patient data extracted from this endpoint is treated in accordance with applicable HIPAA guidelines and strict patient consent. You must provide patients with a clear, transparent Privacy Policy explaining what data is gathered, how it is secured, and what third parties have access to it. Developers must never resell, leak, or abuse patient clinical data.

3. Fair Usage and API Rate Limits

To ensure high availability and prevent Denial of Service events, the facade imposes rate limits. Excessive request velocity or scraping will result in queries being temporarily throttled (HTTP 429 Too Many Requests). We reserve the right to suspend clients showing abusive querying behaviors.

4. ONC Certification & Real World Testing

This API is certified under the ONC Health IT Certification Program. As part of this certification, Nexapoint Health conducts periodic Real World Testing (RWT) to ensure continued compliance and reliability across live production installations.

View the current plan here: Nexapoint Health Real World Testing Plan (2026)