PrevHealth API documentation

Resources and search parameters

Generated from the server CapabilityStatement (GET [base]/metadata). Do not edit by hand; run yarn docs:api in fhir/server to regenerate. The live metadata response is authoritative.

FHIR version: 4.0.1. Formats: application/fhir+json, json, application/fhir+ndjson.

Summary

Resource Interactions Search parameters
Group read —
Patient read, search-type _id, identifier, name, family, given, gender, birthdate, death-date
Observation read, search-type patient, category, code, date, status, _lastUpdated
QuestionnaireResponse read, search-type patient, _id, authored, questionnaire, status
ServiceRequest read, search-type _id, patient, code, category, authored, status
DiagnosticReport read, search-type patient, _lastUpdated, category, date, code, status
Organization read, search-type name, address
Location read, search-type name, address-city, address-state, address-postalcode
Endpoint read, search-type _id, organization
Encounter read, search-type patient, date, class, type, status, identifier, location, discharge-disposition, _lastUpdated
AllergyIntolerance read, search-type patient, clinical-status
CarePlan read, search-type patient, category, status, date
CareTeam read, search-type patient, status, role
Condition read, search-type patient, category, code, clinical-status, encounter, onset-date, abatement-date, recorded-date, asserted-date, _lastUpdated
Coverage read, search-type patient, status
Device read, search-type patient, type, status
DocumentReference read, search-type _id, patient, category, date, type, status, period
Goal read, search-type patient, lifecycle-status, description, target-date
Immunization read, search-type patient, status, date
Medication read, search-type code
MedicationDispense read, search-type patient, status, type
MedicationRequest read, search-type patient, status, intent, authoredon, encounter
Procedure read, search-type patient, status, code
Practitioner read, search-type identifier, name
Provenance read, search-type target, patient
RelatedPerson read, search-type patient, relationship, name
Specimen read, search-type patient, type
Questionnaire read, search-type url, version, _id, name
PractitionerRole read, search-type _id, practitioner, specialty

Group

Interactions: read. Operation: $export (http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export).

Patient

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
_id token
identifier token
name string
family string
given string
gender token
birthdate date
death-date date

Observation

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
category token
code token
date date
status token
_lastUpdated date

QuestionnaireResponse

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
_id token
authored date
questionnaire reference
status token

ServiceRequest

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
_id token
patient reference
code token
category token
authored date
status token

DiagnosticReport

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
_lastUpdated date
category token
date date
code token
status token

Organization

Interactions: read, search-type.

Supported profiles:

Search parameter Type
name string
address string

Location

Interactions: read, search-type.

Supported profiles:

Search parameter Type
name string
address-city string
address-state string
address-postalcode string

Endpoint

Interactions: read, search-type.

Search parameter Type
_id token
organization reference

Encounter

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
date date
class token
type token
status token
identifier token
location reference
discharge-disposition token
_lastUpdated date

AllergyIntolerance

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
clinical-status token

CarePlan

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
category token
status token
date date

CareTeam

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token
role token

Condition

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
category token
code token
clinical-status token
encounter reference
onset-date date
abatement-date date
recorded-date date
asserted-date date
_lastUpdated date

Coverage

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token

Device

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
type token
status token

DocumentReference

Interactions: read, search-type. Supported _revinclude: Provenance:target. Operation: $docref (http://hl7.org/fhir/us/core/OperationDefinition/docref).

Supported profiles:

Search parameter Type
_id token
patient reference
category token
date date
type token
status token
period date

Goal

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
lifecycle-status token
description token
target-date date

Immunization

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token
date date

Medication

Interactions: read, search-type.

Supported profiles:

Search parameter Type
code token

MedicationDispense

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token
type token

MedicationRequest

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token
intent token
authoredon date
encounter reference

Procedure

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
status token
code token

Practitioner

Interactions: read, search-type.

Supported profiles:

Search parameter Type
identifier token
name string

Provenance

Interactions: read, search-type.

Supported profiles:

Search parameter Type
target reference
patient reference

RelatedPerson

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
relationship token
name string

Specimen

Interactions: read, search-type. Supported _revinclude: Provenance:target.

Supported profiles:

Search parameter Type
patient reference
type token

Questionnaire

Interactions: read, search-type.

Search parameter Type
url uri
version token
_id token
name string

PractitionerRole

Interactions: read, search-type.

Supported profiles:

Search parameter Type
_id token
practitioner reference
specialty token