Meditab uses Google Analytics to understand how users interact with our website, helping us improve your experience. Data collected (e.g., pages visited, time spent, location) is anonymized and stored securely, with no personal information shared. Learn more via Google's Privacy Policy . To opt out, adjust your browser settings or use the Google Analytics Opt-out Add-on . By clicking “Accept”, you consent to this data collection.
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.
This profile is used to define the content returned by the API Server in response to different search requests like ID & by patient to access AllergyIntolerance resources.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/AllergyIntolerance/AllergyIntolerance-482
1.1.2. HTTP Method : GET
1.1.3. Parameter
| Name | Description | Required/Optional |
|---|---|---|
| Resource ID(string) | The Resource ID of the AllergyIntolerance resource. | Required |
1.2. Response
{
"resourceType": "AllergyIntolerance",
"id": "AllergyIntolerance-85-22",
"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"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"code": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown"
}
],
"text": "ALLERGY TO FOOD"
},
"patient": {
"reference": "Patient/85"
},
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "135882008",
"display": "Feverish cold (finding)"
}
]
}
]
}
]
}
| Name | Description | Required/Optional |
|---|---|---|
| AllergyIntolerance | A single AllergyIntolerance resource | Required |
| Name | Description | Required/Optional |
|---|
clinicalStatus (CodeableConcept)
The current status of the allergy. Possible values include:
Required
verificationStatus (CodeableConcept)
If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed".
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/AllergyIntolerance?patient=85
2.1.2. HTTP Method : GET
2.1.3. Parameter
Response Code
Description
Required/Optional
Patient ID(reference)
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
The Resource ID of the AllergyIntolerance resource.
2.2. Response
{
"resourceType": "Bundle",
"id": "e7891e28-22a5-48ef-8e1d-d3100e85aa37",
"meta": {
"lastUpdated": "2022-11-18T14:25:53.528+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/AllergyIntolerance?_id=AllergyIntolerance-85-18"
}
],
"entry": [
{
"resource": {
"resourceType": "AllergyIntolerance",
"id": "AllergyIntolerance-85-18",
"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"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "1292899",
"display": "penicillin G"
}
]
},
"patient": {
"reference": "Patient/85"
},
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "315256004",
"display": "Itching of pigmented skin lesion (disorder)"
}
]
}
]
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
clinicalStatus (CodeableConcept)
The current status of the allergy. Possible values include:
Required
verificationStatus (CodeableConcept)
If the allergy is on the patient's chart, this element specifies "confirmed". If it is a newly created allergy and still needs to be reconciled, it is "unconfirmed".
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The FHIR patient resource defines demographics and other administrative information about a person receiving care at a health organization.
In order to match and deliver a patient search request, one of the following minimal data sets is required by default.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Patient/85
1.1.2. HTTP Method : GET
1.1.3. Parameter
Response Code
Description
Required/Optional
1.2. Response
{
"resourceType": "Patient",
"id": "85",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"extension": [
{
"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": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "race"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non - Hispanic/Latino"
}
},
{
"url": "text",
"valueString": "ethnicity"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "UNK"
}
],
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS"
}
]
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "946481516"
}
],
"active": true,
"name": [
{
"text": "Tejas",
"family": "Test5",
"given": [
"Tejas",
"G"
],
"suffix": [
"Jr"
]
},
{
"text": "Tejas",
"family": "Test1",
"given": [
"Tejas",
"G"
],
"period": {
"start": "2022-11-09T05:00:18+00:00",
"end": "2022-11-09T05:26:42+00:00"
}
},
{
"text": "Tejas",
"family": "Test3",
"given": [
"Tejas",
"G"
],
"period": {
"start": "2022-11-09T05:26:42+00:00"
}
}
],
"telecom": [
{
"system": "phone",
"value": "(555)-723-1544",
"use": "home"
},
{
"system": "phone",
"value": "(555)-777-1234",
"use": "mobile"
}
],
"gender": "male",
"birthDate": "2013-07-31",
"address": [
{
"line": [
"1357, Amber Dr, Beaverton"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3"
},
{
"line": [
"1357, Amber Dr, Beaverton"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3",
"period": {
"start": "2022-11-09T05:00:18+00:00"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married"
}
]
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "eng",
"display": "English"
}
]
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
Communication (BackboneElement)
A list of languages used to communicate with the patient, along with an indicator of which is preferred.
Required
name (HumanName)
The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Patient?_id=85
2.1.2. HTTP Method : GET
2.1.3. Parameter
Response Code
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "f1dc250b-88ab-4824-a8d5-fda7b438cf47",
"meta": {
"lastUpdated": "2022-11-18T14:48:44.419+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Patient?_id=85"
}
],
"entry": [
{
"resource": {
"resourceType": "Patient",
"id": "85",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"extension": [
{
"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": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "race"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non - Hispanic/Latino"
}
},
{
"url": "text",
"valueString": "ethnicity"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "UNK"
}
],
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS"
}
]
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "946481516"
}
],
"active": true,
"name": [
{
"text": "Tejas",
"family": "Test5",
"given": [
"Tejas",
"G"
],
"suffix": [
"Jr"
]
},
{
"text": "Tejas",
"family": "Test1",
"given": [
"Tejas",
"G"
],
"period": {
"start": "2022-11-09T05:00:18+00:00",
"end": "2022-11-09T05:26:42+00:00"
}
},
{
"text": "Tejas",
"family": "Test3",
"given": [
"Tejas",
"G"
],
"period": {
"start": "2022-11-09T05:26:42+00:00"
}
}
],
"telecom": [
{
"system": "phone",
"value": "(555)-723-1544",
"use": "home"
},
{
"system": "phone",
"value": "(555)-777-1234",
"use": "mobile"
}
],
"gender": "male",
"birthDate": "2013-07-31",
"address": [
{
"line": [
"1357, Amber Dr, Beaverton"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3"
},
{
"line": [
"1357, Amber Dr, Beaverton"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3",
"period": {
"start": "2022-11-09T05:00:18+00:00"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "Married"
}
]
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "eng",
"display": "English"
}
]
}
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
name (HumanName)
The patient's family (last), Given (First & Middle) name, Prefix or Suffix in a codeable concept or string.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The encounter resource defines the setting where patient care takes place. This includes ambulatory, inpatient, emergency, home health, and virtual encounters.
Encounter is primarily used to record information about the actual activities that occurred , where appointment is used to record planned activities.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Encounter/Encounter-112-385
1.1.2. HTTP Method : GET
1.1.3. Parameter
Response Code
Description
Required/Optional
1.2. Response
{
"resourceType": "Encounter",
"id": "Encounter-112-385",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"system": "https://onchit-fhir.meditab.com/Encounter/Identifier",
"value": "Encounter-112-385"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB",
"display": "ambulatory"
},
"type": [
{
"text": "Office Visit"
}
],
"subject": {
"reference": "Patient/85"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
]
}
],
"period": {
"start": "2015-06-22T04:55:00+00:00",
"end": "2015-07-22T00:00:00+00:00"
},
"individual": {
"reference": "Practitioner/Practitioner-2"
}
}
],
"period": {
"start": "2015-06-22T04:55:00+00:00",
"end": "2015-06-22T05:25:00+00:00"
},
"reasonCode": [
{
"text": "Nebulizer Therapy"
}
],
"hospitalization": {
"dischargeDisposition": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
"code": "oth",
"display": "Other"
}
]
}
},
"location": [
{
"location": {
"reference": "Location/Location-1"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
type
Date (MM-DD-YYYY) of the patient.
Required
location (BackboneElement)
Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Encounter?_id=Encounter-112-385
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "8364cc12-a082-49f2-917c-25009d3b0567",
"meta": {
"lastUpdated": "2022-11-18T14:57:10.722+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Encounter?_id=Encounter-112-385"
}
],
"entry": [
{
"resource": {
"resourceType": "Encounter",
"id": "Encounter-112-385",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"system": "https://onchit-fhir.meditab.com/Encounter/Identifier",
"value": "Encounter-112-385"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB",
"display": "ambulatory"
},
"type": [
{
"text": "Office Visit"
}
],
"subject": {
"reference": "Patient/85"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
]
}
],
"period": {
"start": "2015-06-22T04:55:00+00:00",
"end": "2015-07-22T00:00:00+00:00"
},
"individual": {
"reference": "Practitioner/Practitioner-2"
}
}
],
"period": {
"start": "2015-06-22T04:55:00+00:00",
"end": "2015-06-22T05:25:00+00:00"
},
"reasonCode": [
{
"text": "Nebulizer Therapy"
}
],
"hospitalization": {
"dischargeDisposition": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/discharge-disposition",
"code": "oth",
"display": "Other"
}
]
}
},
"location": [
{
"location": {
"reference": "Location/Location-1"
}
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
location (BackboneElement)
Location reference id. Can return a department, location, hospital room, or bed. Department and location are determined dynamically depending on a variety of factors.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
A patient’s immunization history, including information on the vaccine and vaccine administration, is provided via the FHIR Immunization resource.This resource contains the functionality to query a patient’s immunization history.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Immunization/Immunization-Patient1
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Immunization",
"id": "Immunization-Patient1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"statusReason": {
"coding": [
{
"system": "http://snomed.info/sct"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "106",
"display": "Tetanus and diptheria toxoids"
}
]
},
"patient": {
"reference": "Patient/3"
},
"occurrenceDateTime": "2012-04-01T00:00:00+00:00",
"primarySource": false,
"location": {
"reference": "Organization/Organization-1"
},
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"
}
]
},
"doseQuantity": {
"value": 0.000
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Immunization?_id=Immunization-Patient7
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "1804183c-db19-45e6-9573-60131172701b",
"meta": {
"lastUpdated": "2022-11-21T06:21:22.772+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Immunization?_id=Immunization-Patient7"
}
],
"entry": [
{
"resource": {
"resourceType": "Immunization",
"id": "Immunization-Patient7",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"statusReason": {
"coding": [
{
"system": "http://snomed.info/sct"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "106",
"display": "Tetanus and diptheria toxoids"
}
]
},
"patient": {
"reference": "Patient/85"
},
"occurrenceDateTime": "2012-01-04T00:00:00+00:00",
"primarySource": false,
"location": {
"reference": "Organization/Organization-1"
},
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration"
}
]
},
"doseQuantity": {
"value": 0.000
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
patient(Reference)
Whether the immunization data is historical and therefore reported by a patient or another system.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The goal resource lists the goals that are intended for a patient. A goal is often defined as a desirable result or health state that a patient is to accomplish over time or at a particular moment in time.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Goal/Goal-4
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Goal",
"id": "Goal-4",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
]
},
"lifecycleStatus": "active",
"achievementStatus": {
"text": "not achieved"
},
"description": {
"text": "a. Get rid of intermittent fever that is occurring every few weeks.\r\nb. Need to gain more energy to do regular activities."
},
"subject": {
"reference": "Patient/85"
},
"startDate": "2022-09-26",
"target": [
{
"measure": {
"text": "61146-7"
},
"dueDate": "2022-12-30"
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
description (CodeableConcept)
What the goal entails. SNOMED code or other text describing the goal.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Goal?_id=Goal-4
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "555d63a3-53e5-4023-895b-1436c05c0b98",
"meta": {
"lastUpdated": "2022-11-21T06:35:35.794+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Goal?_id=Goal-4"
}
],
"entry": [
{
"resource": {
"resourceType": "Goal",
"id": "Goal-4",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
]
},
"lifecycleStatus": "active",
"achievementStatus": {
"text": "not achieved"
},
"description": {
"text": "a. Get rid of intermittent fever that is occurring every few weeks.\r\nb. Need to gain more energy to do regular activities."
},
"subject": {
"reference": "Patient/85"
},
"startDate": "2022-09-26",
"target": [
{
"measure": {
"text": "61146-7"
},
"dueDate": "2022-12-30"
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
description (CodeableConcept)
What the goal entails. SNOMED code or other text describing the goal.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The condition resource is used to record problems, diagnosis , or other health issues affecting a patient. Depending on the site, problems and diagnostics are used differently.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Condition/Condition-83
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Condition",
"id": "Condition-2",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active",
"display": "Health Concern"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed",
"display": "Confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category",
"code": "health-concern",
"display": "Health Concern"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386661006",
"display": "Fever (finding)"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter--"
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
clinicalStatus (CodeableConcept)
The current status of the condition. Possible values include:
Required
verificationStatus (CodeableConcept)
If the condition is on the patient's chart, this element specifies "confirmed".
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Condition?_id=Condition-Problem-83
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "613f2f13-2bad-42d1-ac07-ac65b3c3fb3e",
"meta": {
"lastUpdated": "2022-11-21T06:49:51.679+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Condition?_id=Condition-Problem-83"
}
],
"entry": [
{
"resource": {
"resourceType": "Condition",
"id": "Condition-Problem-83",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved",
"display": "Resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed",
"display": "Confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category",
"code": "problem-list-item",
"display": "Problem List Item"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "238131007",
"display": "Overweight (finding)"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112"
},
"onsetDateTime": "2006-12-31T05:32:53+00:00"
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
clinicalStatus (CodeableConcept)
The current status of the condition. Possible values include:
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The organizational resource describes a grouping of people or business units relevant to the healthcare process. Organizations include hospitals, employers, insurance companies, medical practices, rehabilitation facilities, laboratories etc.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Condition/Condition-83
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Organization",
"id": "Organization-1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9971816761"
}
],
"active": true,
"name": "Neighborhood Physicians Practice",
"telecom": [
{
"system": "phone",
"value": "(525)-555-1002"
},
{
"system": "email"
},
{
"system": "fax",
"value": "123-123-1231"
}
],
"address": [
{
"line": [
"2472, Rocky place, Beaverton, OR-97006"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3",
"country": "USA"
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
type (CodeableConcept)
This element supports the following extensible bindings:
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Organization?_id=Organization-1
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "19fdc00a-e79e-45fb-b3ca-a17aabd15d67",
"meta": {
"lastUpdated": "2022-11-21T07:06:44.509+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Organization?_id=Organization-1"
}
],
"entry": [
{
"resource": {
"resourceType": "Organization",
"id": "Organization-1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9971816761"
}
],
"active": true,
"name": "Neighborhood Physicians Practice",
"telecom": [
{
"system": "phone",
"value": "(525)-555-1002"
},
{
"system": "email"
},
{
"system": "fax",
"value": "123-123-1231"
}
],
"address": [
{
"line": [
"2472, Rocky place, Beaverton, OR-97006"
],
"city": "Beaverton",
"state": "OR",
"postalCode": "3",
"country": "USA"
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
type (CodeableConcept)
This element supports the following extensible bindings:
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The MedicationRequest resource provides orders for all the medications along with administration instructions for a patient in both inpatient and outpatient settings(orders/prescriptions filled by a pharmacy and discharge medication orders). This resource also includes a patient’s historical or documented home medications as reported by the patient, their spouse or another provider.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/MedicationRequest/MedicationRequest-254
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "MedicationRequest",
"id": "MedicationRequest-254",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"reportedBoolean": false,
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "RX00000082",
"display": "CELEXA 20 MG TABLET"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-387"
},
"authoredOn": "2020-09-10T00:57:55+00:00",
"requester": {
"reference": "Practitioner/Practitioner-6"
},
"dosageInstruction": [
{
"text": "1 every evening"
}
],
"dispenseRequest": {
"numberOfRepeatsAllowed": 2,
"quantity": {
"value": 30.000000,
"unit": "Tablet",
"system": "http://unitsofmeasure.org",
"code": "C48542"
},
"expectedSupplyDuration": {
"value": 30,
"unit": "days",
"system": "http://unitsofmeasure.org",
"code": "d"
}
},
"substitution": {
"allowedBoolean": true
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
intent (code)
Returns “plan” for patient-reported and historical medications. Returns “order” for other medications.
Required
reportedBoolean (Boolean)
True or False (If Prescription By is set to self or Sample then False)
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/MedicationRequest?_id=MedicationRequest-254
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "839e3fb5-380d-44ed-a293-dee8b6e19b57",
"meta": {
"lastUpdated": "2022-11-21T07:32:44.204+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/MedicationRequest?_id=MedicationRequest-254"
}
],
"entry": [
{
"resource": {
"resourceType": "MedicationRequest",
"id": "MedicationRequest-254",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"reportedBoolean": false,
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "RX00000082",
"display": "CELEXA 20 MG TABLET"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-387"
},
"authoredOn": "2020-09-10T00:57:55+00:00",
"requester": {
"reference": "Practitioner/Practitioner-6"
},
"dosageInstruction": [
{
"text": "1 every evening"
}
],
"dispenseRequest": {
"numberOfRepeatsAllowed": 2,
"quantity": {
"value": 30.000000,
"unit": "Tablet",
"system": "http://unitsofmeasure.org",
"code": "C48542"
},
"expectedSupplyDuration": {
"value": 30,
"unit": "days",
"system": "http://unitsofmeasure.org",
"code": "d"
}
},
"substitution": {
"allowedBoolean": true
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
intent (code)
Returns “plan” for patient-reported and historical medications. Returns “order” for other medications.
Required
reportedBoolean (Boolean)
True or False (If Prescription By is set to self or Sample then False)
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The provenance resource returns contextual metadata about the origin of another resource, such as who created or submitted data about the target resource. Commonly , provenance data is requested as part of the search interaction for a different resource , as described in the
FHIR Search Parameters documentation.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/MedicationRequest/MedicationRequest-254
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Provenance",
"id": "Provenance-1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
]
},
"target": [
{
"reference": "Patient/1"
}
],
"recorded": "2007-09-29T00:00:00.000+00:00",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author",
"display": "author"
}
]
},
"who": {
"reference": "Practitioner/Practitioner-2"
},
"onBehalfOf": {
"reference": "Organization/Organization-1"
}
},
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
"code": "transmitter",
"display": "transmitter"
}
]
},
"who": {
"reference": "Practitioner/Practitioner-2"
},
"onBehalfOf": {
"reference": "Organization/Organization-1"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
agent(CodeableConcept)
Actors involved, such as the author and transmitter.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The procedure resources return medical and surgical procedures performed on or for a patient during their lifetime. Historical procedures as well as procedures recorded during a specific visit are returned. Surgical procedures from finalized closed surgical cases are returned as free text procedures if the solution has been configured to write closed case procedures to the procedure history.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Procedure/Procedure-5-99215
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Procedure",
"id": "Procedure-5-99215",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "99215"
}
]
},
"subject": {
"reference": "Patient/Patient--1"
},
"encounter": {
"reference": "Encounter/Encounter--1"
},
"performedDateTime": "2008-05-06T00:00:00+00:00"
}
Name
Description
Required/Optional
Name
Description
Required/Optional
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
1.1. Request
1.1.1. URL - /mps/fhir/R4/Procedure?_id=Procedure-5-99215
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Bundle",
"id": "908006e3-8582-4713-aded-47947dc570d0",
"meta": {
"lastUpdated": "2022-11-21T07:51:14.260+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Procedure?_id=Procedure-5-99215"
}
],
"entry": [
{
"resource": {
"resourceType": "Procedure",
"id": "Procedure-5-99215",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "99215"
}
]
},
"subject": {
"reference": "Patient/Patient--1"
},
"encounter": {
"reference": "Encounter/Encounter--1"
},
"performedDateTime": "2008-05-06T00:00:00+00:00"
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The FHIR device resource describes information on durable , manufactured medical items.Read interactions begin when a client has previously established a relationship, typically when following a reference to that resource from another resource or by querying for devices through the search interaction.
1. Read
1.1. Request
1.1.1. URL - /fhir/R4/Device/Device-4
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Device",
"id": "Device-4",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "00643169007222",
"carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"
}
],
"distinctIdentifier": "NA",
"manufacturer": "MEDTRONIC, INC.",
"manufactureDate": "2011-01-28T00:00:00+00:00",
"expirationDate": "2016-01-28T00:00:00+00:00",
"lotNumber": "LT6594",
"serialNumber": "BLC200461H",
"modelNumber": "DTBA1QQ",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "code",
"display": "Cardiac resynchronization therapy implantable defibrillator"
}
],
"text": "Cardiac resynchronization therapy implantable defibrillator"
},
"patient": {
"reference": "Patient/85"
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
udiCarrier (BackboneElement)
The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components
These provide access to useful information about the device. The specificity of the UDI
The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Device?_id=Device-4
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "d39170ac-18a2-43c1-b554-9fa0a242a556",
"meta": {
"lastUpdated": "2022-11-21T07:59:17.827+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Device?_id=Device-4"
}
],
"entry": [
{
"resource": {
"resourceType": "Device",
"id": "Device-4",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "00643169007222",
"carrierHRF": "(01)00643169007222(17)160128(21)BLC200461H"
}
],
"distinctIdentifier": "NA",
"manufacturer": "MEDTRONIC, INC.",
"manufactureDate": "2011-01-28T00:00:00+00:00",
"expirationDate": "2016-01-28T00:00:00+00:00",
"lotNumber": "LT6594",
"serialNumber": "BLC200461H",
"modelNumber": "DTBA1QQ",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "code",
"display": "Cardiac resynchronization therapy implantable defibrillator"
}
],
"text": "Cardiac resynchronization therapy implantable defibrillator"
},
"patient": {
"reference": "Patient/85"
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
udiCarrier (BackboneElement)
The unique device identification (UDI) is a unique numeric or alphanumeric code related to a medical device. It allows for a clear and unambiguous identification of specific devices on the market and facilitates their traceability. The UDI comprises the following components
These provide access to useful information about the device. The specificity of the UDI
The UDI will be an addition to, not a substitute for, the existing labeling requirements for medical devices.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The practitioner resource provides information about an individual formally involved in the care of a patient on behalf of a healthcare facility. Practitioners include physicians, nurses, pharmacists, therapists, technologists, and social workers , among others.The read interaction allows you to store only the ID and get the most up-to-date role information on a practitioner with a single request. Read interactions typically begin with a client having previously established a relationship.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Practitioner/Practitioner-2
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Practitioner",
"id": "Practitioner-2",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9036838370"
}
],
"active": true,
"name": [
{
"family": "Davis",
"given": [
"Albert",
"H"
],
"suffix": [
"Dr"
]
}
],
"telecom": [
{
"system": "phone"
},
{
"system": "email",
"value": "tejasp@meditab.com"
}
],
"gender": "male"
}
Name
Description
Required/Optional
Name
Description
Required/Optional
name (HumanName)
The name of the practitioner, including all prefixes and suffixes available.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/Practitioner?_id=Practitioner-2
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "c8dae86d-d54a-4d43-8509-433e5e7e2d03",
"meta": {
"lastUpdated": "2022-11-21T08:11:15.998+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Practitioner?_id=Practitioner-2"
}
],
"entry": [
{
"resource": {
"resourceType": "Practitioner",
"id": "Practitioner-2",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9036838370"
}
],
"active": true,
"name": [
{
"family": "Davis",
"given": [
"Albert",
"H"
],
"suffix": [
"Dr"
]
}
],
"telecom": [
{
"system": "phone"
},
{
"system": "email",
"value": "tejasp@meditab.com"
}
],
"gender": "male"
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
name (HumanName)
The name of the practitioner, including all prefixes and suffixes available.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The care plan resource describes the intentions of how one or more physicians plan to deliver a particular patient. Care plans are used in a variety of areas and applications ranging from encounters or specific visits to mutual visits. Care Plans are used to group activities, goals and practitioners to provide context. Care plans should be patient specific. It is possible that a planned activity without a care plan, such as a scheduled appointment, stands alone.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/CarePlan/CarePlan-385-18776-5
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "CarePlan",
"id": "CarePlan-385-18776-5",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">i. Get An EKG done on 06/23/2015.\r\nii. Get a Chest X-ray done on 06/23/2015 showing the Lower Respiratory Tract Sturucture.\r\niii. Take Clindamycin 300mg Three times a day as needed if pain does not subside.\r\niv. Schedule follow on visit with Neighborhood Physicians Practice on 07/01/2015.\r\n</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
}
],
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
text (Narrative)
The note(s) associated with this encounter-level CarePlanThe practitioner or user ID.
Required
category (CodeableConcept)
In addition, category type "assess-plan" is always included in search results.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/CarePlan?_id=CarePlan-385-18776-5
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "1f432d74-2e14-4dfc-8ee6-1fd73602c28c",
"meta": {
"lastUpdated": "2022-11-21T08:34:06.948+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/CarePlan?_id=CarePlan-385-18776-5"
}
],
"entry": [
{
"resource": {
"resourceType": "CarePlan",
"id": "CarePlan-385-18776-5",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "additional",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">i. Get An EKG done on 06/23/2015.\r\nii. Get a Chest X-ray done on 06/23/2015 showing the Lower Respiratory Tract Sturucture.\r\niii. Take Clindamycin 300mg Three times a day as needed if pain does not subside.\r\niv. Schedule follow on visit with Neighborhood Physicians Practice on 07/01/2015.\r\n</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
}
],
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
category (CodeableConcept)
In addition, category type "assess-plan" is always included in search results.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
The care team resource represents a patient’s care team members. The members or participants of the care team include practitioners(doctors, nurses, technicians, etc). Family members, friends, guardians and the patient. The care team can be specific to an encounter or to the patient across all encounters.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/CareTeam/CareTeam-2
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "CareTeam",
"id": "CareTeam-2",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"name": "Test 1",
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
},
"participant": [
{
"role": [
{
"text": "Provider"
}
],
"member": {
"reference": "Practitioner/Practitioner-2"
}
},
{
"role": [
{
"text": "Provider"
}
],
"member": {
"reference": "Practitioner/Practitioner-107"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/CareTeam?_id=CareTeam-2
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "c75b050e-fda6-4573-a773-241eb19653fc",
"meta": {
"lastUpdated": "2022-11-21T08:48:55.403+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/CareTeam?_id=CareTeam-2"
}
],
"entry": [
{
"resource": {
"resourceType": "CareTeam",
"id": "CareTeam-2",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"name": "Test 1",
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
},
"participant": [
{
"role": [
{
"text": "Provider"
}
],
"member": {
"reference": "Practitioner/Practitioner-2"
}
},
{
"role": [
{
"text": "Provider"
}
],
"member": {
"reference": "Practitioner/Practitioner-107"
}
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
Vital signs, laboratory results, imaging results, device measurements, clinical evaluation tools, personal traits, social history, and core features are all defined in the FHIR Observation resource.
One of the first areas where a single, universal vocabulary is required to enable universal access and re-use is in the field of vital signs. Particularly when patients are using wearables and need or want to exchange information from those devices.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/Observation/Observation-vital-Body-Temperature-385-2-C-85
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "Observation",
"id": "Observation-vital-Body-Temperature-385-2-C-85",
"meta": {
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp"
]
},
"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": "8310-5",
"display": "Body Temperature"
}
]
},
"subject": {
"reference": "Patient/85"
},
"effectiveDateTime": "2022-09-26T00:00:00+00:00",
"valueQuantity": {
"value": 100.40,
"unit": "degF",
"system": "http://unitsofmeasure.org",
"code": "[degF]"
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
valueQuantity(Quantity)
This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements is required.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /fhir/R4/Observation?_id=Observation-vital-Body-Temperature-385-2-C-85
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "8ae4f1fc-3c65-4c06-b8f3-df66645dbc7b",
"meta": {
"lastUpdated": "2022-11-21T08:56:20.428+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/Observation?_id=Observation-vital-Body-Temperature-385-2-C-85"
}
],
"entry": [
{
"resource": {
"resourceType": "Observation",
"id": "Observation-vital-Body-Temperature-385-2-C-85",
"meta": {
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp"
]
},
"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": "8310-5",
"display": "Body Temperature"
}
]
},
"subject": {
"reference": "Patient/85"
},
"effectiveDateTime": "2022-09-26T00:00:00+00:00",
"valueQuantity": {
"value": 100.40,
"unit": "degF",
"system": "http://unitsofmeasure.org",
"code": "[degF]"
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
valueQuantity(Quantity)
This element is populated if a value has units or the data type is numeric or a percentile. Only one of the value* elements are required.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
Within the healthcare system, a patient's clinical document is referred to using the DocumentReference resource. This tool provides a link to get a document as a PDF, a list of clinical documents, and assistance for viewing continuity of care papers (CCD).
1. Read
1.1. Request
1.1.1. URL - /fhir/R4/DocumentReference/DocumentReference-OD-366
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "DocumentReference",
"id": "DocumentReference-OD-366",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"value": "DocumentReference-OD-366"
}
],
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consultation Note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/7"
},
"date": "2020-06-22T00:00:00.000+00:00",
"author": [
{
"reference": "Practitioner/Practitioner-2"
}
],
"custodian": {
"reference": "Organization/Organization-1"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "RHIgQWxiZXJ0IERhdmlzIGRpYWdub3NlZCBNcyBIYXBweSBLaWQgdG8gYmUgc3VmZmVyaW5nIGZyb20gRmV2ZXIgYW5kIHN1c3BlY3RlZCBQbmV1bW9uaWEgYW5kIHJlY29tbWVuZGVkIGFkbWlzc2lvbiB0byB0aGUgQ29tbXVuaXR5IEhlYWx0aCBIb3NwaXRhbHMuIFRoZSBub3RlIHdhcyByZWNvcmRlZCBvbiAyMm5kIEp1bmUgYXQgMTE6MDAgYW0gRVQuDQo="
},
"format": {
"display": "Text format"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/Encounter-4-366"
}
],
"period": {
"start": "2020-06-22T03:41:00+00:00",
"end": "2020-06-22T03:56:00+00:00"
}
}
}
Name
Description
Required/Optional
Name
Description
Required/Optional
type (CodeableConcept)
Refer to below mentioned LOINC code, which need to be sent if it is mapped with question template/question.
When ''18748-4'' Then
''Imaging Narrative''
When ''11526-1'' Then
''Pathology Narrative''
When ''11502-2'' Then
''Laboratory Narrative''
When ''11488-4'' Then
''Consultation Note''
When ''11506-3'' Then
''Progress Note''
When ''34117-2'' Then
''History & Physical Note''
When ""28570-0"" Then
""Procedure note
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/DocumentReference?_id=DocumentReference-OD-366
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
type(CodeableConcept)
Required
2.2. Response
{
"resourceType": "Bundle",
"id": "f3fcc6db-a6c5-48d5-9fbe-50fd4e049282",
"meta": {
"lastUpdated": "2022-11-21T09:14:04.175+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/DocumentReference?_id=DocumentReference-OD-366"
}
],
"entry": [
{
"resource": {
"resourceType": "DocumentReference",
"id": "DocumentReference-OD-366",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"value": "DocumentReference-OD-366"
}
],
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consultation Note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/7"
},
"date": "2020-06-22T00:00:00.000+00:00",
"author": [
{
"reference": "Practitioner/Practitioner-2"
}
],
"custodian": {
"reference": "Organization/Organization-1"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "RHIgQWxiZXJ0IERhdmlzIGRpYWdub3NlZCBNcyBIYXBweSBLaWQgdG8gYmUgc3VmZmVyaW5nIGZyb20gRmV2ZXIgYW5kIHN1c3BlY3RlZCBQbmV1bW9uaWEgYW5kIHJlY29tbWVuZGVkIGFkbWlzc2lvbiB0byB0aGUgQ29tbXVuaXR5IEhlYWx0aCBIb3NwaXRhbHMuIFRoZSBub3RlIHdhcyByZWNvcmRlZCBvbiAyMm5kIEp1bmUgYXQgMTE6MDAgYW0gRVQuDQo="
},
"format": {
"display": "Text format"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/Encounter-4-366"
}
],
"period": {
"start": "2020-06-22T03:41:00+00:00",
"end": "2020-06-22T03:56:00+00:00"
}
}
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
type (CodeableConcept)
Refer to below mentioned LOINC code, which need to be sent if it is mapped with question template/question.
When ''18748-4'' Then
''Imaging Narrative''
When ''11526-1'' Then
''Pathology Narrative''
When ''11502-2'' Then
''Laboratory Narrative''
When ''11488-4'' Then
''Consultation Note''
When ''11506-3'' Then
''Progress Note''
When ''34117-2'' Then
''History & Physical Note''
When ""28570-0"" Then
""Procedure note
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The mix varies depending on the nature of the diagnostic procedure, and sometimes on the nature of the outcomes for a particular investigation.
1. Read
1.1. Request
1.1.1. URL - /mps/fhir/R4/DiagnosticReport/DiagnosticReport-L-448-173
1.1.2. HTTP Method : GET
1.1.3. Parameter
Name
Description
Required/Optional
1.2. Response
{
"resourceType": "DiagnosticReport",
"id": "DiagnosticReport-L-448-173",
"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": "24357-6",
"display": "URINALYSIS,MACROSCOPIC"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
},
"effectiveDateTime": "2022-09-26T00:00:00+00:00",
"issued": "2022-09-26T06:21:55.400+00:00",
"performer": [
{
"reference": "Organization/Organization-1"
}
],
"result": [
{
"reference": "Observation/Observation-lab-448-173-385"
},
{
"reference": "Observation/Observation-lab-448-173-388"
},
{
"reference": "Observation/Observation-lab-448-173-389"
},
{
"reference": "Observation/Observation-lab-448-173-390"
},
{
"reference": "Observation/Observation-lab-448-173-393"
},
{
"reference": "Observation/Observation-lab-448-173-394"
},
{
"reference": "Observation/Observation-lab-448-173-396"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "Q2pFNU5URXRNRGt0TURRS0NpTWdRMmhwWldZZ1EyOXRjR3hoYVc1MENrNXZJR052YlhCc1lXbHVkSE11Q2dvaklFaHBjM1J2Y25rZ2IyWWdVSEpsYzJWdWRDQkpiR3h1WlhOekNreDFZMmxsYmpRd09DQnBjeUJoSURFeElIbGxZWEl0YjJ4a0lHNXZiaTFvYVhOd1lXNXBZeUIzYUdsMFpTQnRZV3hsTGlCUVlYUnBaVzUwSUdoaGN5QmhJR2hwYzNSdmNua2diMllnYjNScGRHbHpJRzFsWkdsaExDQmhZM1YwWlNCMmFYSmhiQ0J3YUdGeWVXNW5hWFJwY3lBb1pHbHpiM0prWlhJcExDQm1jbUZqZEhWeVpTQnZaaUJqYkdGMmFXTnNaUzRLQ2lNZ1UyOWphV0ZzSUVocGMzUnZjbmtLSUZCaGRHbGxiblFnYUdGeklHNWxkbVZ5SUhOdGIydGxaQ0JoYm1RZ2FYTWdZVzRnWVd4amIyaHZiR2xqTGdvS1VHRjBhV1Z1ZENCamIyMWxjeUJtY205dElHRWdhR2xuYUNCemIyTnBiMlZqYjI1dmJXbGpJR0poWTJ0bmNtOTFibVF1SUZCaGRHbGxiblFnWTNWeWNtVnVkR3g1SUdoaGN5QkNiSFZsSUVOeWIzTnpJRUpzZFdVZ1UyaHBaV3hrTGdvS0l5QkJiR3hsY21kcFpYTUtUbThnUzI1dmQyNGdRV3hzWlhKbmFXVnpMZ29LSXlCTlpXUnBZMkYwYVc5dWN3cHdaVzVwWTJsc2JHbHVJR2NnTXpjMUlHMW5MMjFzSUdsdWFtVmpkR0ZpYkdVZ2MyOXNkWFJwYjI0N0lHRnpjR2x5YVc0Z09ERWdiV2NnYjNKaGJDQjBZV0pzWlhRS0NpTWdRWE56WlhOemJXVnVkQ0JoYm1RZ1VHeGhiZ3BRWVhScFpXNTBJR2x6SUhCeVpYTmxiblJwYm1jZ2QybDBhQ0IyYVhKaGJDQnphVzUxYzJsMGFYTWdLR1JwYzI5eVpHVnlLUzRnQ2dvakl5QlFiR0Z1Q2dwVWFHVWdabTlzYkc5M2FXNW5JSEJ5YjJObFpIVnlaWE1nZDJWeVpTQmpiMjVrZFdOMFpXUTZDaTBnYldWa2FXTmhkR2x2YmlCeVpXTnZibU5wYkdsaGRHbHZiaUFvY0hKdlkyVmtkWEpsS1FwVWFHVWdjR0YwYVdWdWRDQjNZWE1nY0hKbGMyTnlhV0psWkNCMGFHVWdabTlzYkc5M2FXNW5JRzFsWkdsallYUnBiMjV6T2dvdElHRnRiM2hwWTJsc2JHbHVJREkxTUNCdFp5QXZJR05zWVhaMWJHRnVZWFJsSURFeU5TQnRaeUJ2Y21Gc0lIUmhZbXhsZEFv"
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
category (CodeableConcept)
The service category. This can be LAB, Imaging or any other category type supported by IMS.
Required
subject(Reference)
Reference to a patient resource for whom the diagnostic report is relevant.
Required
encounter(Reference)
Reference to an encounter resource for whom the diagnostic report is relevant.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
2.1. Request
2.1.1. URL - /mps/fhir/R4/DiagnosticReport?_id=DiagnosticReport-L-448-173
2.1.2. HTTP Method : GET
2.1.3. Parameter
Name
Description
Required/Optional
2.2. Response
{
"resourceType": "Bundle",
"id": "74479011-d133-4b85-b588-b4016d7d9a04",
"meta": {
"lastUpdated": "2022-11-21T09:02:18.646+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://172.26.60.114:2525/mps/fhir/R4/DiagnosticReport?_id=DiagnosticReport-L-448-173"
}
],
"entry": [
{
"resource": {
"resourceType": "DiagnosticReport",
"id": "DiagnosticReport-L-448-173",
"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": "24357-6",
"display": "URINALYSIS,MACROSCOPIC"
}
]
},
"subject": {
"reference": "Patient/85"
},
"encounter": {
"reference": "Encounter/Encounter-112-385"
},
"effectiveDateTime": "2022-09-26T00:00:00+00:00",
"issued": "2022-09-26T06:21:55.400+00:00",
"performer": [
{
"reference": "Organization/Organization-1"
}
],
"result": [
{
"reference": "Observation/Observation-lab-448-173-385"
},
{
"reference": "Observation/Observation-lab-448-173-388"
},
{
"reference": "Observation/Observation-lab-448-173-389"
},
{
"reference": "Observation/Observation-lab-448-173-390"
},
{
"reference": "Observation/Observation-lab-448-173-393"
},
{
"reference": "Observation/Observation-lab-448-173-394"
},
{
"reference": "Observation/Observation-lab-448-173-396"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "Q2pFNU5URXRNRGt0TURRS0NpTWdRMmhwWldZZ1EyOXRjR3hoYVc1MENrNXZJR052YlhCc1lXbHVkSE11Q2dvaklFaHBjM1J2Y25rZ2IyWWdVSEpsYzJWdWRDQkpiR3h1WlhOekNreDFZMmxsYmpRd09DQnBjeUJoSURFeElIbGxZWEl0YjJ4a0lHNXZiaTFvYVhOd1lXNXBZeUIzYUdsMFpTQnRZV3hsTGlCUVlYUnBaVzUwSUdoaGN5QmhJR2hwYzNSdmNua2diMllnYjNScGRHbHpJRzFsWkdsaExDQmhZM1YwWlNCMmFYSmhiQ0J3YUdGeWVXNW5hWFJwY3lBb1pHbHpiM0prWlhJcExDQm1jbUZqZEhWeVpTQnZaaUJqYkdGMmFXTnNaUzRLQ2lNZ1UyOWphV0ZzSUVocGMzUnZjbmtLSUZCaGRHbGxiblFnYUdGeklHNWxkbVZ5SUhOdGIydGxaQ0JoYm1RZ2FYTWdZVzRnWVd4amIyaHZiR2xqTGdvS1VHRjBhV1Z1ZENCamIyMWxjeUJtY205dElHRWdhR2xuYUNCemIyTnBiMlZqYjI1dmJXbGpJR0poWTJ0bmNtOTFibVF1SUZCaGRHbGxiblFnWTNWeWNtVnVkR3g1SUdoaGN5QkNiSFZsSUVOeWIzTnpJRUpzZFdVZ1UyaHBaV3hrTGdvS0l5QkJiR3hsY21kcFpYTUtUbThnUzI1dmQyNGdRV3hzWlhKbmFXVnpMZ29LSXlCTlpXUnBZMkYwYVc5dWN3cHdaVzVwWTJsc2JHbHVJR2NnTXpjMUlHMW5MMjFzSUdsdWFtVmpkR0ZpYkdVZ2MyOXNkWFJwYjI0N0lHRnpjR2x5YVc0Z09ERWdiV2NnYjNKaGJDQjBZV0pzWlhRS0NpTWdRWE56WlhOemJXVnVkQ0JoYm1RZ1VHeGhiZ3BRWVhScFpXNTBJR2x6SUhCeVpYTmxiblJwYm1jZ2QybDBhQ0IyYVhKaGJDQnphVzUxYzJsMGFYTWdLR1JwYzI5eVpHVnlLUzRnQ2dvakl5QlFiR0Z1Q2dwVWFHVWdabTlzYkc5M2FXNW5JSEJ5YjJObFpIVnlaWE1nZDJWeVpTQmpiMjVrZFdOMFpXUTZDaTBnYldWa2FXTmhkR2x2YmlCeVpXTnZibU5wYkdsaGRHbHZiaUFvY0hKdlkyVmtkWEpsS1FwVWFHVWdjR0YwYVdWdWRDQjNZWE1nY0hKbGMyTnlhV0psWkNCMGFHVWdabTlzYkc5M2FXNW5JRzFsWkdsallYUnBiMjV6T2dvdElHRnRiM2hwWTJsc2JHbHVJREkxTUNCdFp5QXZJR05zWVhaMWJHRnVZWFJsSURFeU5TQnRaeUJ2Y21Gc0lIUmhZbXhsZEFv"
}
]
},
"search": {
"mode": "match"
}
}
]
}
Name
Description
Required/Optional
Name
Description
Required/Optional
category (CodeableConcept)
The service category. This can be LAB, Imaging or any other category type supported by IMS.
Required
subject(Reference)
Reference to a patient resource for whom the diagnostic report is relevant.
Required
encounter(Reference)
Reference to an encounter resource for whom the diagnostic report is relevant.
Required
entry
An array of entries included in this bundle.
Required
Response Code
Description
200 OK
The requested resource was found and is contained within the body of the HTTP response.
400 Bad Request
The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found
The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone
The requested resource has been permanently deleted from the server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error
The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx Server Error
The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error
IMS (14.0.SP1)
Meditab is an EMR software company and practice management system. We offer leading multispecialty EHR software solutions designed by providers to meet the unique needs of your practice.
Useful Links
Meditab | All Rights Reserved.