Member-authorized CMS Patient Access FHIR R4 API exposing a member's claims, clinical, coverage, and medication data after OAuth 2.0 / SMART-on-FHIR consent. Resources: Patient, Condition, Encounter, Medication, and ExplanationOfBenefit.
{
"swagger": "2.0",
"definitions": {
"Condition": {
"description": "",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"text": {
"type": "object",
"properties": {
"status": {
"type": "string",
"minLength": 1
},
"div": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"div"
]
},
"patient": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
},
"code": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
}
}
},
"text": {
"type": "string",
"minLength": 1
}
},
"required": [
"coding",
"text"
]
},
"category": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"fhir_comments": {
"type": "array",
"items": {
"properties": {}
}
},
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"coding"
]
},
"verificationStatus": {
"type": "string",
"minLength": 1
},
"severity": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"coding"
]
},
"onsetDateTime": {
"type": "string",
"minLength": 1
},
"bodySite": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"text"
],
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
}
}
},
"text": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"resourceType",
"id",
"text",
"patient",
"code",
"category",
"verificationStatus",
"severity",
"onsetDateTime",
"bodySite"
]
},
"Encounter": {
"description": "",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"text": {
"type": "object",
"properties": {
"status": {
"type": "string",
"minLength": 1
},
"div": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"div"
]
},
"status": {
"type": "string",
"minLength": 1
},
"class": {
"type": "string",
"minLength": 1
},
"patient": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
}
},
"required": [
"resourceType",
"id",
"text",
"status",
"class",
"patient"
]
},
"ExplanationOfBenefit": {
"description": "",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"text": {
"type": "object",
"properties": {
"status": {
"type": "string",
"minLength": 1
},
"div": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"div"
]
},
"identifier": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"value"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"value": {
"type": "string",
"minLength": 1
}
}
}
},
"request": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
},
"outcome": {
"type": "string",
"minLength": 1
},
"disposition": {
"type": "string",
"minLength": 1
},
"created": {
"type": "string",
"minLength": 1
},
"organization": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
},
"requestOrganization": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
}
},
"required": [
"resourceType",
"id",
"text",
"identifier",
"request",
"outcome",
"disposition",
"created",
"organization",
"requestOrganization"
]
},
"Medication": {
"description": "",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"text": {
"type": "object",
"properties": {
"status": {
"type": "string",
"minLength": 1
},
"div": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"div"
]
},
"code": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
},
"_display": {
"type": "object",
"properties": {
"fhir_comments": {
"type": "array",
"items": {
"properties": {}
}
}
},
"required": [
"fhir_comments"
]
}
}
}
}
},
"required": [
"coding"
]
},
"isBrand": {
"type": "boolean"
},
"package": {
"type": "object",
"properties": {
"fhir_comments": {
"type": "array",
"items": {
"properties": {}
}
},
"container": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code",
"display"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"coding"
]
}
},
"required": [
"fhir_comments",
"container"
]
}
},
"required": [
"resourceType",
"id",
"text",
"code",
"isBrand",
"package"
]
},
"Patient": {
"description": "",
"type": "object",
"properties": {
"resourceType": {
"type": "string",
"minLength": 1
},
"id": {
"type": "string",
"minLength": 1
},
"text": {
"type": "object",
"properties": {
"status": {
"type": "string",
"minLength": 1
},
"div": {
"type": "string",
"minLength": 1
}
},
"required": [
"status",
"div"
]
},
"identifier": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"use",
"system",
"value"
],
"properties": {
"use": {
"type": "string",
"minLength": 1
},
"type": {
"type": "object",
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"coding"
]
},
"system": {
"type": "string",
"minLength": 1
},
"value": {
"type": "string",
"minLength": 1
}
}
}
},
"active": {
"type": "boolean"
},
"name": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"use"
],
"properties": {
"use": {
"type": "string",
"minLength": 1
},
"family": {
"type": "array",
"items": {
"properties": {}
}
},
"given": {
"type": "array",
"items": {
"properties": {}
}
}
}
}
},
"gender": {
"type": "string",
"minLength": 1
},
"photo": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"contentType",
"data"
],
"properties": {
"contentType": {
"type": "string",
"minLength": 1
},
"data": {
"type": "string",
"minLength": 1
}
}
}
},
"contact": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"properties": {
"relationship": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"properties": {
"coding": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"system",
"code"
],
"properties": {
"system": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
}
}
}
}
}
}
},
"organization": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference",
"display"
]
}
}
}
},
"managingOrganization": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
},
"display": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference",
"display"
]
},
"link": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"required": [
"type"
],
"properties": {
"other": {
"type": "object",
"properties": {
"reference": {
"type": "string",
"minLength": 1
}
},
"required": [
"reference"
]
},
"type": {
"type": "string",
"minLength": 1
}
}
}
}
},
"required": [
"resourceType",
"id",
"text",
"identifier",
"active",
"name",
"gender",
"photo",
"contact",
"managingOrganization",
"link"
]
}
},
"paths": {
"/Condition": {
"get": {
"tags": [
"Condition"
],
"parameters": [
{
"name": "patient",
"type": "string",
"in": "query",
"description": "Who has the condition. It is a required field."
},
{
"name": "_format",
"in": "query",
"type": "string",
"x-consoleDefault": "application/json"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Condition"
}
}
}
}
}
},
"/Condition/{id}": {
"parameters": [
{
"in": "path",
"required": true,
"name": "id",
"type": "string"
}
]
},
"/Encounter": {
"get": {
"tags": [
"Encounter"
],
"parameters": [
{
"name": "patient",
"type": "string",
"in": "query",
"description": "The patient present at the encounter. It is a required field."
},
{
"name": "date",
"type": "string",
"in": "query",
"description": "A date or date range from which to find appointments. This must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range.",
"format": "date"
},
{
"name": "_format",
"in": "query",
"type": "string",
"x-consoleDefault": "application/json"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Encounter"
}
}
}
}
}
},
"/Encounter/{id}": {
"parameters": [
{
"in": "path",
"required": true,
"name": "id",
"type": "string"
}
]
},
"/ExplanationOfBenefit": {
"get": {
"tags": [
"ExplanationOfBenefit"
],
"parameters": [
{
"name": "patient",
"type": "string",
"in": "query",
"description": "The patient present at the encounter. It is a required field."
},
{
"name": "date",
"type": "string",
"in": "query",
"description": "A date or date range from which to find appointments. This must be set when using patient, practitioner or location. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for appointments at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for appointments within a specific range. The date prefix pair must create a closed range.",
"format": "date"
},
{
"name": "_format",
"in": "query",
"type": "string",
"x-consoleDefault": "application/json"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ExplanationOfBenefit"
}
}
}
}
}
},
"/ExplanationOfBenefit/{id}": {
"parameters": [
{
"in": "path",
"required": true,
"name": "id",
"type": "string"
}
]
},
"/Medication": {
"get": {
"tags": [
"Medication"
],
"parameters": [
{
"name": "patient",
"type": "string",
"in": "query",
"description": "The patient to return MedicationRequests for. It is a required field."
},
{
"name": "_format",
"in": "query",
"type": "string",
"x-consoleDefault": "application/json"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Medication"
}
}
}
}
}
},
"/Medication/{id}": {
"parameters": [
{
"in": "path",
"required": true,
"name": "id",
"type": "string"
}
]
},
"/Patient": {
"get": {
"tags": [
"Patient"
],
"parameters": [
{
"name": "_id",
"type": "string",
"in": "query",
"description": "A patient identifier. Either the '_id' parameter, or 'identifier' must be provided."
},
{
"name": "identifier",
"type": "string",
"in": "query",
"description": "A patient identifier. Either the '_id' parameter, or 'identifier' must be provided."
},
{
"name": "_format",
"in": "query",
"type": "string",
"x-consoleDefault": "application/json"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Patient"
}
}
}
}
}
},
"/Patient/{id}": {
"parameters": [
{
"in": "path",
"required": true,
"name": "id",
"type": "string"
}
],
"get": {
"tags": [
"Patient"
],
"parameters": [],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Patient"
}
}
}
}
}
},
"info": {
"description": "Fast Healthcare Interoperability Resources (FHIR, pronounced \"Fire\") defines a set of \"Resources\" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation. \n",
"title": "Untitled",
"version": "unspecified"
},
"host": "api.prod.devoted.com",
"schemes": [
"https"
],
"basePath": "/fhir/",
"tags": [
{
"name": "CapabilityStatement"
},
{
"name": "Condition"
},
{
"name": "Encounter"
},
{
"name": "ExplanationOfBenefit"
},
{
"name": "Medication"
},
{
"name": "Patient"
}
]
}