AllergyIntolerance

GET/AllergyIntolerance/{id} Gets the Allergy intolerance resource for given allergyId.

Fetches a single allergy/intolerance record by id.

FHIR Resource: AllergyIntolerance
      Medication Allergies
     Substance (Drug Class)
     Substance (Medication)
     Reaction

Parameters
     Name : id * required string (path)       Description : allergyId

GET/AllergyIntolerance Gets bundle of Allergy intolerance resource.

Fetches a bundled resource containing the allergy/intolerance records for the patient mentioned in the request. FHIR Resource: AllergyIntolerance
      Medication Allergies
      Substance (Drug Class)
     Substance (Medication)
     Reaction

Parameters
     Name : _id string (query)       Description : Allergy id
      Name : patient string (query)       Description : Who the sensitivity is for.
     Name : date string (query)       Description : When allergy or intolerance was identified.
     Name : _revinclude string (query)       Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

CarePlan

GET/CarePlan/{id} Gets the Careplan resource for given carePlanId.

Fetches a single plan of treatment(care plans, orders) and assessment note by id.

FHIR Resource: CarePlan
      Assessment and Plan of Treatment

Parameters
      Name : id * required string (path)
      Description : carePlanId

GET/CarePlan Gets bundle of Careplan resource.

Fetches a bundled resource containing plan of treatment(care plans, orders) and assessment notes for the patient mentioned in the request.

FHIR Resource: CarePlan
      Assessment and Plan of Treatment

Parameters
      Name :_id string (query)      Description : CarePlan id
     Name : patient string (query)      Description : Who the care plan is for.
     Name : category string (query)      Description : Type of plan.
     Name : status string (query)      Description :Careplan status
     Name : _revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

CareTeam

GET/CareTeam/{id} Gets CareTeamMember resource for given careTeamMemberId.

Fetches a single Care Team member by id.

FHIR Resource: CareTeam
     Care Team

Parameters
      Name : id * required string (path)
     Description : careTeamMemberId

GET/CareTeam Gets bundle of CareTeam resource.

Fetches a bundled resource containing details of the Care Team members for the patient mentioned in the request.

FHIR Resource: CareTeam
      Care Team

Parameters
     Name : _id string (query)      Description : CareTeam id
     Name : patient string (query)      Description : Who care team is for
     Name :status string (query)      Description : status
     Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Condition

GET/Condition/{id} Gets Condition resource for given conditionId.

Fetches a Condition resource containing the condition/problem associated with the provided resource id.

FHIR Resource: Condition
     Health Concerns      Problems      Encounter Diagnosis

Parameters
      Name : id * required string (path)
     Description : conditionId

GET/Condition Gets bundle of Condition resource.

Fetches a bundled resource containing the condition/problem associated with the provided resource id.

FHIR Resource: Condition
     Health Concerns
      Problems
     Encounter Diagnosis

Parameters
      Name : _id string (query)      Description : Condition id
      Name :patient string (query)      Description : Who has the condition?
      Name :category string (query)      Description :Condition category
      Name : onset-date string (query)      Description :Date related onsets.
      Name : clinical-status string (query)      Description : status.
      Name : _revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Device

GET/DiagnosticReport/{id} Gets Device resource for given deviceId.

Fetches a single implantable device by id.

FHIR Resource: Device
     Unique Device Identifier(s) for Patients Implantable Device(s)

Parameters
      Name : id * required string (path)
     Description : deviceId

GET/Device Gets bundle of device resource.

Fetches a bundled resource containing all the implantable devices for the patient mentioned in the request.

FHIR Resource: Device
      Unique Device Identifier(s) for Patients Implantable Device(s)

Parameters
      Name : _id string (query)      Description : Device id
      Name : patient string (query)      Description : Patient information, if the resource is affixed to a person.
      Name : status string (query)      Description :The availability status of the device.
      Name : _revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

DiagnosticReport

GET/DiagnosticReport/{id} Gets Diagnostic report resource for given orderTestId.

Fetches a single lab, radiology, cardiology or pathology report by id. The observations and/or documents are contained in the resource.

FHIR Resource for Report and Note Exchange: DiagnosticReport
     Radiology Report
     Cardiology Report
     Pathology Report

FHIR Resource for Lab Results Reporting: Observation, DiagnosticReport
      Tests
     Values/Results

Parameters
      Name : id * required string (path)
     Description : orderTestId

GET/DiagnosticReport Gets bundle of DiagnosticReport resource.

Fetches a bundled resource containing all the lab, radiology, cardiology or pathology reports. The observations and/or documents are contained in the resource.

FHIR Resource for Report and Note Exchange: DiagnosticReport
     Radiology Report
     Cardiology Report
     Pathology Report

FHIR Resource for Lab Results Reporting: Observation, DiagnosticReport
     Tests
     Values/Results

Parameters
      Name : _id string (query)      Description :Diagnostic Report id
      Name :patient string (query)      Description : patientId
      Name :category string (query)      Description : A code that classifies the clinical discipline, department or diagnostic service that created the report.
      Name :code string (query)      Description :A code or name that describes this diagnostic report.
      Name : date string (query)      Description : Obtained date/time. If the obtained element is a period, a date that falls in the period
      Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

DocumentReference

GET/DocumentReference/{id} Gets DocumentReference resource for given documentReferenceId.

Fetches a single Document Reference. A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed.

FHIR Resource: DocumentReference
     Consultation Note
     Discharge Summary Note
     History & Physical Note
     Procedures Note
     Progress Note
     Imaging Narrative
     Laboratory Report Narrative
     Pathology Report Narrative

Parameters
      Name : id * required string (path)
     Description : documentReferenceId.

GET/DocumentReference Gets bundle of DocumentReference resource.

Fetches a bundled resource containing the valid Document References for the patient mentioned in the request.

FHIR Resource: DocumentReference
     Consultation Note
     Discharge Summary Note
     History & Physical Note
     Procedures Note
     Progress Note
     Imaging Narrative
     Laboratory Report Narrative
     Pathology Report Narrative

Parameters
      Name : _id string (query)      Description :Document Reference id
      Name : patient string (query)      Description :Who/what is the subject of the document.
      Name :patient type string (query)      Description :Specifies the particular kind of document referenced (LOINC Code).
      Name :date string (query)      Description :When the document reference was created.
      Name :category string (query)      Description :A categorization for the type of document referenced.
      Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Encounter

GET/Encounter/{id} Gets Encounter resource for given encounterId.

Fetches a single Encounter. An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

FHIR Resource: Encounter
      Encounters
FHIR Resource: Location
     Location

Parameters
      Name : id * required string (path)
     Description : encounterId.

GET/Encounter Gets bundle of Encounter resource.

Fetches a bundled resource containing the valid encounters for the patient mentioned in the request.

FHIR Resource: Encounter
     Encounters
FHIR Resource: Location
     Location

Parameters
      Name : _id string (query)      Description :Encounter id
      Name : patient string (query)      Description :The patient or group present at the encounter.
      Name :date string (query)      Description :A date within the period the encounter lasted.
      Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Goal

GET/Goal/{id} Gets Goal resource for given goalId.

Fetches a single Goal by id.

FHIR Resource: Goal
     Patient Goals

Parameters
      Name : id * required string (path)
     Description : goalId.

GET/Goal Gets bundle of Goal resource.

Fetches a bundled resource containing the health concern goals for the patient mentioned in the request.

FHIR Resource: Goal
     Patient Goals

Parameters
      Name : _id string (query)      Description :Goal id
      Name : patient string (query)      Description :Who this goal is intended for?
      Name :target-date string (query)      Description :Reach goal on or before.
      Name :lifecycle-status string (query)      Description :State of the goal throughout its lifecycle.
      Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Immunization

GET/Immunization/{id} Gets Immunization resource for given immunizationId.

Fetches a single immunization record by id.

FHIR Resource: Immunization
      Immunization

Parameters
      Name : id * required string (path)
     Description : immunizationId.

GET/Immunization Gets Bundle of Immunization Resource

Fetches a bundled resource containing the immunization records for the patient mentioned in the request.

FHIR Resource: Immunization
     Immunization

Parameters
      Name : _id string (query)      Description :Immunization id
      Name : patient string (query)      Description :The patient for the vaccination record
      Name :date string (query)      Description :Vaccination (non)-Administration Date.
      Name :status string (query)      Description :Immunization event status
      Name : _revinclude string (query)      Description : To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Location

GET/Location/{id} Gets location resource

Fetches Location by id. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

FHIR Resource: Location
     Location

Parameters
      Name : id * required string (path)
     Description : LocationId.

GET/Location Gets location bundle response

Fetches Bundled resource of locations. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

FHIR Resource: Location
      Location

Parameters
      Name : _id string (query)      Description :Device id
      Name : name string(query)      Description :Location name
      Name :address string (query)      Description :Address of the location.
      Name :address-city string (query)      Description :A city specified in an address.
      Name : address-state string (query)      Description : A state specified in an address.
      Name : address-postalcode string (query)      Description : A postal code specified in an address.

MedicationRequest

GET/MedicationRequest/{id} Gets Medication request resource for given medicationRequestId.

Fetches a single medication prescription record by id. Medications are mapped to RxNorm codes.

FHIR Resource: MedicationRequest
      Medications

Parameters
      Name : id * required string (path)
     Description : medicationRequestId.

GET/MedicationRequest Gets bundle of Medication request resource.

Fetches a bundled resource containing all the medication prescription records for the patient mentioned in the request. Medications are mapped to RxNorm codes.

FHIR Resource: MedicationRequest
      Medications

Parameters
      Name : _id string (query)      Description :MedicationRequest id
      Name : patient string(query)      Description :The identity of a patient to list orders for.
      Name :status string (query)      Description :Status of the prescription
      Name :intent string (query)      Description :intent code
      Name : authoredon string (query)      Description : date on which a prescription was written
      Name : _revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

MedicationStatement

GET/MedicationStatement/{id} Gets Medication Statement resource for given medicationStatementId.

Fetches a single medication statement record by id.

FHIR Resource: MedicationStatement

Parameters
      Name : id * required string (path)
     Description : medicationStatementId.

GET/MedicationStatement Gets bundle of Medication statement resource.

Fetches a bundled resource of medication statement records.

FHIR Resource: MedicationStatement

Parameters
      Name : _id string (query)      Description :MedicationStatement id
      Name : patient string(query)      Description :patientId
      Name :status string (query)      Description :Status

Observation

GET/Observation/{id} Gets Observation resource for given observationId.

Fetches a single observation by id.

FHIR Resource: Observation
     Diastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
     Systolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
     Body Height - Body height (FHIR Core Profile)
     Body Weight - Body weight (FHIR Core Profile)
     Heart Rate - Heart rate (FHIR Core Profile)
     Respiratory Rate - Body temperature (FHIR Core Profile)
     Body Temperature - Body temperature (FHIR Core Profile)
     Pulse Oximetry - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile)
     Inhaled Oxygen Concentration - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile)
     BMI Percentile (2-20 years old) - US Core Pediatric BMI for Age Observation Profile (Builds on FHIR Core Profile)
     Weight-for-Length Percentile (Birth-36 months) - US Core Pediatric Weight for Height Observation Profile (Builds on FHIR Core Profile)
     Occipital-frontal Head Circumference Percentile (Birth-36 months) - US Core Pediatric Head Occipital Frontal Circumference Observation Profile (Builds on FHIR Core Profile)
     Smoking Status

Parameters
      Name : id * required string (path)
     Description : observationId for laboratory, vital-signs or social-history.

GET/Observation Gets bundle of Observation resource.

Fetches a bundled resource containing the observations. for the patient mentioned in the request.

FHIR Resource: Observation
     Diastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
     Systolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile)
     Body Height - Body height (FHIR Core Profile)
     Body Weight - Body weight (FHIR Core Profile)
     Heart Rate - Heart rate (FHIR Core Profile)
     Respiratory Rate - Body temperature (FHIR Core Profile)
     Body Temperature - Body temperature (FHIR Core Profile)
     Pulse Oximetry - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile)
     Inhaled Oxygen Concentration - US Core Pulse Oximetry Profile (Builds on FHIR Core Profile)
     BMI Percentile (2-20 years old) - US Core Pediatric BMI for Age Observation Profile (Builds on FHIR Core Profile)
     Weight-for-Length Percentile (Birth-36 months) - US Core Pediatric Weight for Height Observation Profile (Builds on FHIR Core Profile)
     Occipital-frontal Head Circumference Percentile (Birth-36 months) - US Core Pediatric Head Occipital Frontal Circumference Observation Profile (Builds on FHIR Core Profile)
     Smoking Status

Parameters
      Name : _id string (query)      Description :Observation id
      Name : patient string(query)      Description :patientId
      Name :category string (query)      Description :The classification of the type of observation laboratory, vital-signs or social-history.
      Name :code string (query)      Description :The code of the observation type
      Name :date string (query)      Description :Obtained date/time. If the obtained element is a period, a date that falls in the period
      Name :status string (query)      Description :Codes providing the status of an observation
      Name :_revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Organization

GET/Organization/{id} Gets Organization resource for given organizationId.

Fetches an Organization by id. Organization is a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

FHIR Resource: Organization
     Organization

Parameters
      Name : id * required string (path)
     Description : organizationId.

GET/Organization Gets bundle of Organization resource.

Fetches a Bundled resource of Organizations. Organization is a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.

FHIR Resource: Organization
      Organization

Parameters
      Name : _id string (query)      Description :Organization id
      Name : name string(query)      Description :A portion of the organization's name or alias.
      Name :address string (query)      Description :A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text.
      Name :address-city string (query)      Description :A city specified in an address.
      Name :address-postalcode string (query)      Description :A postal code specified in an address.
      Name :address-state string (query)      Description :A state specified in an address.
      Name :address-country string (query)      Description :A country specified in an address.

Patient

GET/Patient/{id} Gets Patient resource for given patientId.

Fetches a single Patient by patient Id

FHIR Resource: Patient.name.given
     First Name
     Middle Name
FHIR Resource: Patient.name.family
     Last Name
FHIR Resource: Patient.name
     Previous Name
FHIR Resource: Patient.name.suffix
     Suffix
FHIR Resource: US Core Birth Sex Extension
     Birth Sex
FHIR Resource: Patient.birthDate
     Date of Birth
FHIR Resource: US Core Race Extension
     Race
FHIR Resource: US Core Ethnicity Extension
     Ethnicity
FHIR Resource: Patient.communication
     Preferred Language
FHIR Resource: Patient.address
     Address
FHIR Resource: Patient.telecom
     Phone Number

Parameters
      Name : id * required string (path)
     Description : patientId.

GET/Patient Gets bundle of Patient resource.

Fetches a bundled resource containing the valid patients mentioned in the request parameters.

FHIR Resource: Patient.name.given
     First Name
     Middle Name
FHIR Resource: Patient.name.family
     Last Name
FHIR Resource: Patient.name
     Previous Name
FHIR Resource: Patient.name.suffix
     Suffix
FHIR Resource: US Core Birth Sex Extension
     Birth Sex
FHIR Resource: Patient.birthDate
      Date of Birth
FHIR Resource: US Core Race Extension
     Race
FHIR Resource: US Core Ethnicity Extension
     Ethnicity
FHIR Resource: Patient.communication
     Preferred Language
FHIR Resource: Patient.address
     Address
FHIR Resource: Patient.telecom
     Phone Number

Parameters
      Name : _id string (query)      Description :Patient id
      Name : identifier string(query)      Description :identifier.
      Name :name string (query)      Description :patient name
      Name :given string (query)      Description :A portion of the given name of the patient.
      Name :family string (query)      Description :A portion of the family name of the patient.
      Name :gender string (query)      Description :Gender of the patient
      Name :address string (query)      Description :A server defined search that may match any of the string in the Address line1.
      Name :address-city string (query)      Description :A city specified in an address
      Name :address-postalcode string (query)      Description :A postalCode specified in an address.
      Name :birthdate string (query)      Description :The patient's date of birth.
      Name :page string (query)      Description :Next page number for search results
      Name :_revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource

Practitioner

GET/Practitioner/{id} Gets Practitioner resource for given practitionerId.

Fetches a Practitioner by id. Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

FHIR Resource: Practitioner
     Practitioner

Parameters
      Name : id * required string (path)
     Description : practitionerId.

GET/Practitioner Gets bundle of Practitioner resource.

Fetches a bundled resource of Practitioners. Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

FHIR Resource: Practitioner
     Practitioner

Parameters
      Name : _id string (query)      Description :Practitioner id
      Name : name string(query)      Description :A server defined search that may match any of the string fields in the HumanName, including firstName,lastName,middleName.
      Name :identifier string (query)      Description :A practitioner's Identifier.

Procedure

GET/Procedure/{id} Gets Procedure resource for given procedureId.

Fetches a single Procedure by id.

FHIR Resource: Procedure
      Procedures

Parameters
      Name : id * required string (path)
     Description : procedureId.

GET/Procedure Gets bundle of Procedure resource.

Fetches a bundled resource containing the valid procedures for the patient mentioned in the request. The procedures pertain to the encounters available for the patient.

FHIR Resource: Procedure
      Procedures

Parameters
      Name : _id string (query)      Description :Procedure id
      Name : patient string(query)      Description :patientid
      Name :date string (query)      Description :When the procedure was performed.
      Name :status string (query)      Description :A code specifying the state of the procedure.
      Name :_revinclude string (query)      Description :To Search for Provenance of resource. ex: _revinclude = Provenance:target to get provenance resource.

Provenance

GET/Provenance/{id} Gets the Provenance resource for given provenanceId.

Fetches Provenance by id. Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource.

FHIR Resource: Provenance.recorded
      Author Time Stamp
FHIR Resource: Provenance.agent

Parameters
      Name : id * required string (path)
     Description : provenanceId.

RelatedPerson

GET/RelatedPerson/{id} Gets Related person resource for given relatedPersonId.

Gets Related person resource for given Related PersonId. A RelatedPerson resource is referenced in CareTeam resources.

Parameters
      Name : id * required string (path)
     Description : relatedPersonId.

GET/RelatedPerson Gets bundle of Related person resource.

Gets RelatedPerson resources referenced in CareTeam resources.

Parameters
      Name : _id string (query)      Description :RelatedPerson id
      Name : patient string(query)      Description :The patient this related person is related to.
      Name :name string (query)      Description :A server defined search that may match any of the string fields in the HumanName, including firstName, lastName.

CapabilityStatement

GET/metadata Gets CapabilityStatement.

Parameters
No parameters