API docs by Redocly

WRS Health FHIR Server (v 7.0)

Download OpenAPI specification:Download

E-mail: info@wrshealth.com License: Apache 2.0 Terms of Service

WRS Health offers a FHIR Server for interoperable use of our healthcare data using the open standards developed by HL7. The FHIR standard format allows for easier data processing and exchange through common off-the-shelf frameworks which support the FHIR data model and REST services.

Technical documentation regarding FHIR resources and API methods to interoperate with WRS Health FHIR platform will be found here. Default syntax is JSON, authorization is performed by using OAuth2 (under TLS 1.2), and all HTTP methods follow the REST syntax (GET, POST, PUT, DELETE; PATCH).

No additional components are required to be installed in order to configure the connection to WRS Health FHIR Server.

Default FHIR Server URL: https://api.fhir.wrs.cloud/r4/ .

Current application version: 7.0 (latest)

For more info visit WRS Health Website

App Registration

Developers that want to connect to WRS Health FHIR Server must send an email to fhir@wrshealth.com requesting access. WRS Health FHIR team will reply with the requested information to be fulfilled in order to create a new 3rd party app connection to WRS Health FHIR Server. Such information will require technical and non-technical data to be provided by the developer/3rd party.

Once the registration process is successfully completed, the WRS Health Operations team will proceed to create the user in the Authorization Server and send credentials to the subscriber.

Afterwards, developers can proceed to configure the 3rd party software by following the suggested steps in the "Required Configurations" section.

Required Configurations

Once the registration process is successfully finished and all the access credentials are sent to the developers, the following configurations must be taken into account:

SMART App launch sequence

Authorization process:

  1. Request the authorization code from the Authorization Server (see "SMART Authorization code grant" section). A series of information from the 3rd party software, as well as some information provided by WRS Health (client id and aud), must be provided to create the Authorization code. If the request is successful, this temporary code (Authorization code) will be provided to generate the Access token. Access token will be exchanged in all the following operations done with the WRS Health FHIR Server.

  2. Once the Authorization code is retrieved from the Authorization Server an Access token and a Refresh token must be created (see "Exchange Code for Access token" section). The only external information (not related with the 3rd party software) that must be provided here is the Authorization code, which must be sent in the code query parameter. Also, the client id and client secret (both provided by the WRS Operations team) must be sent in the headers under the Authorization parameter (this must be Base64 encoded in the format client id:client secret ) .

  3. If the request is successful, an Access token will be provided for future interactions with WRS Health FHIR platform by using it as a bearer token in the Authorization header. This code will have a TTL (Time-To-Live) of 5 minutes, and after the expiration a new Access token must be created by submitting the Refresh token created in step 2.

Capability Statement

Set of capabilities (behaviors) this FHIR Server supports in the current implementation.

Capability Statement

Set of capabilities (behaviors) supported by the FHIR server

Responses

SMART configuration

Set of capabilities (behaviors) supported by the FHIR server when using SMART (Substitutable Medical Applications, Reusable Technologies)

Responses

Authorization

Authorization is performed in 2 steps:

  1. An authorization request is sent to the server.
  2. Depending on certain conditions, the server will prompt the End User for consent, or grant the access directly if it is a token refresh.

SMART Authorization code grant

To begin the SMART Authorization code grant you will first be redirected to the Authorization endpoint from your application. The authorization code is a temporary code that the client will exchange for an access token. The code itself is obtained from the authorization server where the user gets a chance to see what information the client is requesting, and approve or deny the request. After obtaining the Authorization code an access token must be requested from the Authorization Server by providing such Authorization code.

query Parameters
response_type
string
Default: "code"

Fixed value: code

client_id
string

Application ID of the authorization requester

redirect_uri
string

URL to be redirected to once the authorization is successful

scope
string

Space-delimited list of permissions (scopes) the application requires

aud
string

URL of this FHIR platform. This parameter prevents leaking a genuine bearer token to a counterfeit resource server

state
string

An opaque value used for security purposes. If this parameter is set, then it will be appended to the redirect_uri parameter in the response

launch
string

Opaque identifier for the specific launch. Your App will be required to communicate this value back to this FHIR platform once you are ready to send an authorization request. This will be used to validate the correctness of a valid Launch Authorization request.

Responses

Exchange Code for Access token

This method is used both for obtaining a new token as well as refreshing an existant one. To obtain a new access token an Authorization code must be obtained first - see: SMART Authorization code grant

query Parameters
code
string

The authorization code returned on the Authorization code grant - see: SMART Authorization code grant

grant_type
string
Enum: "authorization_code" "refresh_token"

Use authorization_code if a new token is to be created, or refresh_token to refresh an existent one

redirect_uri
string

Same URL used in redirect_uri for SMART Authorization code grant

refresh_token
string

Token that will be refreshed if grant_type parameter is set to refresh_token

header Parameters
Authorization
required
string

Basic access authentication by providing client_id and client_secret. This information will be provided by WRS Health after finishing your application registering process. Example of Basic Auth: Authorization: Basic d3JzaXN0aGViZXN0Om15cGFzc3dvcmRydWxlcw==

Responses

Appointment

Appointment resources are used to provide information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance - see: https://www.hl7.org/fhir/appointment.html

Listing appointments

Obtains a list (FHIR Bundle) of all appointments in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
patient
required
string

WRS Health internal Patient ID

status
string

Appointment status to filter. Allowed values: booked, cancelled.

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "type": "searchset",
  • "id": "712ce94f-8747-449b-b3a0-6837adb1706d",
  • "entry": [
    ]
}

Get appointment by id

Returns a single appointment resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Appointment ID

Responses

Response samples

Content type
application/json
{
  • "id": "14421657",
  • "resourceType": "Appointment",
  • "identifier": {
    },
  • "status": "cancelled",
  • "created": "2024-10-15T10:25:31-04:00",
  • "start": "2024-11-01T19:00:00-04:00",
  • "end": "2024-11-01T19:15:00-04:00",
  • "participant": [
    ]
}

Patient

This Resource covers data about patients involved in health-related activities - see: https://www.hl7.org/fhir/patient.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

Listing patients

Obtains a list (FHIR Bundle) of all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal Patient ID

identifier
string

Patient identifier following HL7 rules. See https://build.fhir.org/datatypes.html#Identifier

name
string

Patient name following HL7 rules. See https://build.fhir.org/datatypes.html#HumanName

birthdate
string

Patient birthdate (format: YYYY-MM-DD)

gender
string

Patient gender following HL7 rules. Accepted values: male , female , other , unknown

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "86a737a5-d168-4dc7-8602-2d06350029fc",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get patient by Id

Returns a single patient resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Patient ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Patient",
  • "id": "500",
  • "text": {
    },
  • "identifier": [],
  • "name": [
    ],
  • "telecom": [
    ],
  • "gender": "male",
  • "birthDate": "1984-08-28",
  • "address": [
    ],
  • "maritalStatus": {},
  • "contact": [
    ],
  • "communication": [
    ],
  • "extension": []
}

AllergyIntolerance

A record of a clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance - see: https://www.hl7.org/fhir/allergyintolerance.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-allergyintolerance.html

Listing allergies and intolerances

Obtains a list (FHIR Bundle) of all allergies and intolerances from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal AllergyIntolerance ID

patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{}

Get allergy intolerance by id

Returns a single allergy/intolerance resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal AllergyIntolerance ID

Responses

Response samples

Content type
application/json
{}

Bulk Export

The FHIR Bulk Data Access protocol describes a mechanism for efficiently requesting large amounts of data in a convenient format. This protocol can be used to request all data on a server, or a specific subset that is useful for a given use case - see: http://hl7.org/fhir/uv/bulkdata/export/index.html

Bulk Export

Request a bulk export data job

path Parameters
id
required
string

WRS Health internal group ID

Responses

Bulk Job status

Return the bulk export job status

path Parameters
id
required
string

Job id

Responses

Stop bulk export execution

Stop bulk export job

path Parameters
id
required
string

Job id

Responses

CarePlan

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions - see: https://www.hl7.org/fhir/careplan.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-careplan.html

Listing care plans

Obtains a list (FHIR Bundle) of all care plans from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal CarePlan ID

patient
string

WRS Health internal Patient ID

category
string

Category identifier. Must be a valid code from http://snomed.info/sct where concept is-a 734163000 (Care plan)

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{}

Get care plan by id

Returns a single care plan resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal CarePlan ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "CarePlan",
  • "id": "1",
  • "text": {
    },
  • "status": "active",
  • "intent": "plan",
  • "category": [],
  • "subject": {
    }
}

CareTeam

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient - see: https://www.hl7.org/fhir/careteam.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-careteam.html

Listing care teams

Obtains a list (FHIR Bundle) of all care teams from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal CareTeam ID

patient
string

WRS Health internal Patient ID

status
string

Status identifier. Must be a valid code from https://build.fhir.org/valueset-care-team-status.html. Accepted values: proposed, active, suspended, inactive, entered-in-error

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "5c53050a-4202-4e2b-bb78-f03aa87dc723",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get care team by id

Returns a single care team resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal CareTeam ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "CareTeam",
  • "id": "4",
  • "text": {
    },
  • "status": "proposed",
  • "category": [
    ],
  • "subject": {
    },
  • "participant": [
    ]
}

Condition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern - see: https://www.hl7.org/fhir/condition.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-condition.html

Listing conditions

Obtains a list (FHIR Bundle) of all conditions from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal Condition ID

patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{}

Get condition by id

Returns a single condition resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Condition ID

Responses

Response samples

Content type
application/json
{}

Device

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device - see: https://www.hl7.org/fhir/device.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-implantable-device.html (only for implantable devices)

Listing devices

Obtains a list (FHIR Bundle) of all devices from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal Device ID

patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "5decbaae-ae26-4a09-90c1-84f431db15bb",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get device by id

Returns a single device resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Device ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Device",
  • "id": "1",
  • "text": {
    },
  • "meta": {},
  • "type": {},
  • "lotNumber": "HNEdkE@DARF'l^!\"1,X;",
  • "manufactureDate": "2010-04-18T00:00:00+00:00",
  • "expirationDate": "2001-11-14T00:00:00+00:00",
  • "patient": {
    },
  • "distinctIdentifier": "/4Lh|ux=mVS\"luZ'n6DV",
  • "serialNumber": ":WH-sNmN0)Gm+C:=vn+k",
  • "udiCarrier": [
    ]
}

DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports - see: https://www.hl7.org/fhir/diagnosticreport.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-diagnosticreport-note.html (used for reports and exchange notes) http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-diagnosticreport-lab.html (used for lab results reports)

Listing diagnostic reports

Obtains a list (FHIR Bundle) of all diagnostics reports from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal DiagnosticReport ID

patient
string

WRS Health internal Patient ID

category
code
string

Name/Code for this diagnostic report (LOINC code). Most frequently LOINC codes used: where CLASSTYPE = 2 (for reports and notes) and where CLASSTYPE = 1 (for lab reports)

date
string

The clinically relevant time of the report - see: https://www.hl7.org/fhir/search.html#date

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "09056492-fc71-44ba-89de-a6fd824387ef",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get diagnostic report by id

Returns a single diagnostic report resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal DiagnosticReport ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "DiagnosticReport",
  • "id": "2",
  • "text": {
    },
  • "status": "registered",
  • "category": [
    ],
  • "code": {
    },
  • "subject": {
    },
  • "encounter": {
    },
  • "effectiveDateTime": "2018-04-22T00:42:14+00:00",
  • "issued": "1973-11-05T12:55:32+00:00",
  • "performer": [
    ],
  • "presentedForm": []
}

DocumentReference

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text - see: https://www.hl7.org/fhir/documentreference.html

Profiles used: http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-documentreference.html

Listing documents

Obtains a list (FHIR Bundle) of all documents from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal DocumentReference ID

patient
string

WRS Health internal Patient ID

category
string

Category identifier. Must be a valid code from https://www.hl7.org/fhir/valueset-doc-classcodes.html. Most frequent code used: clinical-note (US Core)

type
string

Type identifier. Must be a valid code from http://hl7.org/fhir/us/core/STU5/ValueSet-us-core-documentreference-type.html. Accepted values: UNK (unknown) and codes from http://loinc.org where SCALE_TYP = DOC

date
string

The date the document reference was created - see: https://www.hl7.org/fhir/search.html#date

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "b4b95477-edfc-41be-89c5-b04904545b27",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 6,
  • "link": [],
  • "entry": [
    ]
}

Get document by id

Returns a single document resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal DocumentReference ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "DocumentReference",
  • "id": "1",
  • "text": {
    },
  • "identifier": [
    ],
  • "status": "current",
  • "docStatus": "preliminary",
  • "type": {
    },
  • "category": [],
  • "subject": {
    },
  • "date": "2006-01-06T00:00:00+00:00",
  • "author": [
    ],
  • "custodian": {
    },
  • "content": [],
  • "context": {
    }
}

Encounter

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient - see: https://www.hl7.org/fhir/encounter.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter

Listing encounters

Obtains a list (FHIR Bundle) of all encounters from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Encounter ID

patient
string

WRS Health internal Patient ID

date
string

A date within the period the Encounter lasted - see: https://www.hl7.org/fhir/search.html#date

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "aa33bff7-78af-4763-bb40-b60f9f3be07a",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get Encounter by id

Returns a single encunter resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Encounter ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Encounter",
  • "id": "1",
  • "text": {
    },
  • "identifier": [],
  • "status": "triaged",
  • "class": {},
  • "type": [],
  • "subject": {
    },
  • "participant": [],
  • "period": {
    },
  • "reasonCode": [
    ],
  • "hospitalization": {
    },
  • "location": [
    ]
}

Goal

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc - see: http://hl7.org/fhir/goal.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal

Listing goals

Obtains a list (FHIR Bundle) of all goals from all patients available in the EHR. Data filtering can be achieved by providing query parameters.

query Parameters
_id
string

WRS Health internal Goal ID

patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "edd5a259-9cfe-4377-981b-1a9146b675ad",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get goal by id

Returns a single goal resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Goal ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Goal",
  • "id": "1",
  • "text": {
    },
  • "lifecycleStatus": "cancelled",
  • "description": {
    },
  • "subject": {
    },
  • "startDate": "2010-01-02",
  • "target": [
    ]
}

Immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party - see: https://www.hl7.org/fhir/immunization.html

Profiles used: http://hl7.org/fhir/us/core/STU5/StructureDefinition-us-core-immunization.html

Listing immunizations

Obtains a list (FHIR Bundle) of all immunizations from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Immunization ID

patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "0e4b47cb-1d49-42e0-a553-55185d357a98",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get immunization by Id

Returns a single immunization resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Immunization ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Immunization",
  • "id": "1",
  • "text": {
    },
  • "status": "entered-in-error",
  • "statusReason": {},
  • "vaccineCode": {
    },
  • "patient": {
    },
  • "occurrenceDateTime": "1985-10-11T12:51:58+00:00",
  • "primarySource": true
}

MedicationRequest

An order or request for both supply of the medication and the instructions for administration of the medication to a patient - see: https://www.hl7.org/fhir/medicationrequest.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest

Listing medications requests

Obtains a list (FHIR Bundle) of all medication requests from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal MedicationRequest ID

patient
string

WRS Health internal Patient ID

intent
string

Intent identifier. Must be a valid code from http://hl7.org/fhir/R4/codesystem-medicationrequest-intent.html. Accepted values: proposal, plan, order, original-order, reflex-order, filler-order, instance-order, option

status
string

A code specifying the current state of the order. Generally, this will be active or completed state. Must be a valid code from http://hl7.org/fhir/R4/codesystem-medicationrequest-status.html. Accepted values: active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

_include
string

List of additional resources that this resource refers to - see: https://www.hl7.org/fhir/search.html#include. Most frequently used: Medication

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "ebc48ea8-d101-48ac-988f-b7cde18889d0",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get medication request by id

Returns a single medication request resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal medication request ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "MedicationRequest",
  • "id": "1",
  • "text": {
    },
  • "status": "cancelled",
  • "intent": "proposal",
  • "reportedBoolean": true,
  • "medicationReference": {
    },
  • "subject": {
    },
  • "encounter": {
    },
  • "authoredOn": "1975-12-01T04:24:05+00:00",
  • "requester": {
    },
  • "dosageInstruction": [
    ]
}

Listing observations

Obtains a list (FHIR Bundle) of all observation from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Observation ID

patient
string

WRS Health internal Patient ID

code
string

Code identifier (type of observation) in LOINC code

category
string

Category code. Must be a valid code from http://hl7.org/fhir/R4B/codesystem-observation-category.html. Accepted values: social-history, vital-signs, imaging, laboratory, procedure, survey, exam, therapy, activity

date
string

Clinically relevant time/time-period for observation - see: https://www.hl7.org/fhir/search.html#date

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "8578ecf8-8a29-4c8d-9bb6-35124caa104a",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 3,
  • "link": [],
  • "entry": [
    ]
}

Get observation by id

Returns a single observation resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Observation ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Observation",
  • "id": "1",
  • "text": {
    },
  • "status": "final",
  • "code": {
    },
  • "subject": {
    },
  • "effectiveDateTime": "2004-09-04T00:00:00+00:00",
  • "issued": "1985-10-12T09:08:13+00:00",
  • "valueCodeableConcept": {}
}

Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc - see: https://www.hl7.org/fhir/organization.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization

Listing organizations

Obtains a list (FHIR Bundle) of all organization available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Organization ID

name
string
address
string

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text - see: https://www.hl7.org/fhir/datatypes.html#Address

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "aa33bff7-78af-4763-bb40-b60f9f3be07a",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get organization by id

Returns a single organization resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Organization ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Organization",
  • "id": "1",
  • "text": {
    },
  • "identifier": [],
  • "active": true,
  • "name": "Ankunding, Konopelski and Glover",
  • "telecom": [
    ],
  • "address": [
    ]
}

Practitioner

Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities - see: https://www.hl7.org/fhir/practitioner.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner

Listing practitioners

Obtains a list (FHIR Bundle) of all practitioner in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Practitioner ID

name
string

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text - see: https://www.hl7.org/fhir/datatypes.html#HumanName

identifier
string
_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "aa33bff7-78af-4763-bb40-b60f9f3be07a",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get practitioner by id

Returns a single practitioner resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Practitioner ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Practitioner",
  • "id": "1",
  • "text": {
    },
  • "identifier": [],
  • "name": [
    ],
  • "telecom": [
    ],
  • "address": [
    ],
  • "gender": "female",
  • "birthDate": "1972-08-12",
  • "communication": [
    ]
}

Procedure

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy - see: https://www.hl7.org/fhir/procedure.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure

Listing procedures

Obtains a list (FHIR Bundle) of all procedure from all patients available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Procedure ID

patient
string

WRS Health internal Patient ID

date
string

When the procedure was performed - see: https://www.hl7.org/fhir/search.html#date

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "id": "aa33bff7-78af-4763-bb40-b60f9f3be07a",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "link": [],
  • "entry": [
    ]
}

Get procedure by id

Returns a single procedure resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Procedure ID

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Procedure",
  • "id": "1",
  • "text": {
    },
  • "status": "unknown",
  • "code": {},
  • "subject": {
    },
  • "performedDateTime": "2014-12-20T00:00:00+00:00"
}

Provenance

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies - see: https://www.hl7.org/fhir/provenance.html

Profiles used: http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance

Listing provenances

Obtains a list (FHIR Bundle) of all provenance in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
_id
string

WRS Health internal Provenance ID

Responses

Response samples

Content type
application/json
{}

Get provenance by id

Returns a single provenance resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Provenance ID

Responses

Response samples

Content type
application/json
{}

Questionnaire

Questionnaire is an organized collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain - see: https://www.hl7.org/fhir/questionnaire.html

Listing questionnaires

Obtains a list (FHIR Bundle) of all questionnaires available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{}

Get questionnaire by id

Returns a single questionnaire resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal Questionnaire ID

Responses

Response samples

Content type
application/json
{}

QuestionnaireResponse

QuestionnaireResponse provides a complete or partial list of answers to a set of questions filled when responding to a questionnaire. The questions may be included directly or by reference to a Questionnaire resource that defines the questions as well as the constraints on the allowed answers - see: https://www.hl7.org/fhir/questionnaireResponse.html

Profiles used: https://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-questionnaireresponse.html

Listing questionnaires

Obtains a list (FHIR Bundle) of all questionnaire responses available in the EHR. Data filtering can be achieved by providing query parameters

query Parameters
patient
string

WRS Health internal Patient ID

_revinclude
string

List of additional resources that refer to this resource - see: https://www.hl7.org/fhir/search.html#revinclude. Most frequently used: Provenance

Responses

Response samples

Content type
application/json
{
  • "resourceType": "Bundle",
  • "type": "searchset",
  • "id": "e2dd1c46-6db9-49f5-96c8-0e0ac1f824e1",
  • "entry": []
}

Get questionnaire response by id

Returns a single questionnaire response resource - if found - based on the provided id

path Parameters
id
required
string

WRS Health internal QuestionnaireResponse ID

Responses

Response samples

Content type
application/json
{
  • "authored": "2024-03-22T14:13:13.975Z",
  • "item": [
    ],
  • "meta": {},
  • "questionnaire": "https://api.fhir.wrs.cloud/r4/Questionnaire/1",
  • "resourceType": "QuestionnaireResponse",
  • "status": "completed",
  • "subject": {
    }
}