I/O Docs: API Documentation
Test our API services using I/O Docs. You can also view our written documentation.
- Select an Interactive Documentation
- FHIR API
- FHIR DSTU2
- FHIR_OAuth_API
Fast Healthcare Interoperability Resources (FHIR, pronounced "Fire") defines a set of "Resources" that represent granular clinical concepts. The resources can be managed in isolation, or aggregated into complex documents. Technically, FHIR is designed for the web; the resources are based on simple XML or JSON structures, with an http-based RESTful protocol where each resource has predictable URL. Where possible, open internet standards are used for data representation.
-
Patient
-
GET PatientList /Patient/$everything
-
GET PatientInfo /Patient/:patientId/$everything
-
-
AllergyIntolerance
-
GET AllergyIntolerance Search /baseDstu2/AllergyIntolerance
-
POST Create AllergyIntolerance /baseDstu2/AllergyIntolerance
-
PUT Update AllergyIntolerance /baseDstu2/AllergyIntolerance/:id
-
DELETE Delete AllergyIntolerance /baseDstu2/AllergyIntolerance/:id
-
GET Get AllergyIntolerance /baseDstu2/AllergyIntolerance/:id
-
GET AllergyIntolerance History /baseDstu2/AllergyIntolerance/:id/_history
-
GET AllergyIntolerances History /baseDstu2/AllergyIntolerance/_history
-
GET AllergyIntolerance Version Read /baseDstu2/AllergyIntolerance/:id/_history/:vid
-
-
Appointment
-
GET Appointment Search /baseDstu2/Appointment
-
POST Create Appointment /baseDstu2/Appointment
-
DELETE Delete Appointment /baseDstu2/Appointment/:id
-
PUT Update Appointment /baseDstu2/Appointment/:id
-
GET Get Appointment /baseDstu2/Appointment/:id
-
GET Appointment History /baseDstu2/Appointment/:id/_history
-
GET Appointments History /baseDstu2/Appointment/_history
-
GET Appointment Version Read /baseDstu2/Appointment/:id/_history/:vid
-
-
Condition
-
GET Condition Search /baseDstu2/Condition
-
POST Create Condition /baseDstu2/Condition
-
DELETE Delete Condition /baseDstu2/Condition/:id
-
GET Get Condition /baseDstu2/Condition/:id
-
PUT Update Condition /baseDstu2/Condition/:id
-
GET Condition History /baseDstu2/Condition/:id/_history
-
GET Conditions History /baseDstu2/Condition/_history
-
GET Condition Version Read /baseDstu2/Condition/:id/_history/:vid
-
-
Medication
-
GET Medication Search /baseDstu2/Medication
-
POST Create Medication /baseDstu2/Medication
-
GET Get Medication /baseDstu2/Medication/:id
-
PUT Update Medication /baseDstu2/Medication/:id
-
DELETE Delete Medication /baseDstu2/Medication/:id
-
GET Medication History /baseDstu2/Medication/:id/_history
-
GET Medications History /baseDstu2/Medication/_history
-
GET Medication Version Read /baseDstu2/Medication/:id/_history/:vid
-
-
MedicationOrder
-
GET MedicationOrder Search /baseDstu2/MedicationOrder
-
POST Create MedicationOrder /baseDstu2/MedicationOrder
-
PUT Update MedicationOrder /baseDstu2/MedicationOrder/:id
-
DELETE Delete MedicationOrder /baseDstu2/MedicationOrder/:id
-
GET Get MedicationOrder /baseDstu2/MedicationOrder/:id
-
GET MedicationOrder History /baseDstu2/MedicationOrder/:id/_history
-
GET MedicationOrders History /baseDstu2/Medication/_history
-
GET MedicationOrder Version Read /baseDstu2/MedicationOrder/:id/_history/:vid
-
-
Patient
-
GET Patient Search /baseDstu2/Patient
-
POST Create Patient /baseDstu2/Patient
-
DELETE Delete Patient /baseDstu2/Patient/:id
-
PUT Update Patient /baseDstu2/Patient/:id
-
GET Get Patient /baseDstu2/Patient/:id
-
GET Patient History /baseDstu2/Patient/:id/_history
-
GET Patients History /baseDstu2/Patient/_history
-
GET Patient Version Read /baseDstu2/Patient/:id/_history/:vid
-
-
Practitioner
-
GET Practitioner Search /baseDstu2/Practitioner
-
GET Get Practitioner /baseDstu2/Practitioner/:id
-
DELETE Delete Practitioner /baseDstu2/Practitioner/:id
-
PUT Update Practitioner /baseDstu2/Practitioner/:id
-
GET Practitioner History /baseDstu2/Practitioner/:id/_history
-
GET Practitioner Version Read /baseDstu2/Practitioner/:id/_history/:vid
-
-
Schedule
-
GET Schedule Search /baseDstu2/Schedule
-
POST Create Schedule /baseDstu2/Schedule
-
PUT Update Schedule /baseDstu2/Schedule/:id
-
GET Get Schedule /baseDstu2/Schedule/:id
-
DELETE Delete Schedule /baseDstu2/Schedule/:id
-
GET Schedule History /baseDstu2/Schedule/:id/_history
-
GET Schedules History /baseDstu2/Schedule/_history
-
GET Schedule Version Read /baseDstu2/Schedule/:id/_history/:vid
-
-
Location
-
GET Location Search /baseDstu2/Location
-
POST Create Location /baseDstu2/Location
-
PUT Update Location /baseDstu2/Location/:id
-
GET Get Location /baseDstu2/Location/:id
-
DELETE Delete Location /baseDstu2/Location/:id
-
GET Location History /baseDstu2/Location/:id/_history
-
GET Locations History /baseDstu2/Location/_history
-
GET Location Version Read /baseDstu2/Location/:id/_history/:vid
-
-
CarePlan
-
GET Search CarePlan baseDstu2/CarePlan
-
POST Create CarePlan /baseDstu2/CarePlan
-
GET Get CarePlan /baseDstu2/CarePlan/:id
-
PUT Update CarePlan /baseDstu2/CarePlan/:id
-
DELETE Delete CarePlan /baseDstu2/CarePlan/:id
-
GET CarePlans History /baseDstu2/CarePlan/_history
-
GET CarePlan History /baseDstu2/CarePlan/:id/_history
-
GET CarePlan Version Read /baseDstu2/CarePlan/:id/_history/:vid
-
-
Procedure
-
GET Search Procedure baseDstu2/Procedure
-
POST Create Procedure /baseDstu2/Procedure
-
GET Get Procedure /baseDstu2/Procedure/:id
-
PUT Update Procedure /baseDstu2/Procedure/:id
-
DELETE Delete Procedure /baseDstu2/Procedure/:id
-
GET Procedures History /baseDstu2/Procedure/_history
-
GET CarePlan History /baseDstu2/Procedure/:id/_history
-
GET CarePlan Version Read /baseDstu2/Procedure/:id/_history/:vid
-
-
EligibilityRequest
-
GET Search EligibilityRequest baseDstu2/EligibilityRequest
-
POST Create EligibilityRequest /baseDstu2/EligibilityRequest
-
GET Get EligibilityRequest /baseDstu2/EligibilityRequest/:id
-
PUT Update EligibilityRequest /baseDstu2/EligibilityRequest/:id
-
DELETE Delete Procedure /baseDstu2/EligibilityRequest/:id
-
GET EligibilityRequests History /baseDstu2/EligibilityRequest/_history
-
GET EligibilityRequest History /baseDstu2/EligibilityRequest/:id/_history
-
GET EligibilityRequest Version Read /baseDstu2/EligibilityRequest/:id/_history/:vid
-
-
PatientOAuth
-
GET Patient /Patient
-