Products /
FHIR Interoperability Product
1.0.0
-
API documentation for the Developer Portal Team's FHIR Interoperability API.
Please note that we have purposefully omitted several fields from our FHIR resource schema definitions below to improve the rendering performance of this Open API Specification. For the complete definition of our FHIR resources, please refer to the official FHIR profiles and our CapabilityStatement.
RESTOnline
Plans
In order to subscribe, you must create an account or sign in.
APIs
| Title | Version | Type | Rate limits | |
|---|---|---|---|---|
| FHIR Interoperability API | 1.0.0 | REST | 100 calls per hour | |
| GET /fhir/.well-known/smart-configuration | 100 calls per hour | |||
| GET /fhir/metadata | 100 calls per hour | |||
| GET /fhir/Patient/{id}/$everything | 100 calls per hour | |||
| GET /fhir/Condition | 100 calls per hour | |||
| GET /fhir/Condition/{id} | 100 calls per hour | |||
| GET /fhir/Condition/{id}/_history | 100 calls per hour | |||
| GET /fhir/Condition/_history | 100 calls per hour | |||
| GET /fhir/Condition/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Coverage | 100 calls per hour | |||
| GET /fhir/Coverage/{id} | 100 calls per hour | |||
| GET /fhir/Coverage/{id}/_history | 100 calls per hour | |||
| GET /fhir/Coverage/_history | 100 calls per hour | |||
| GET /fhir/Coverage/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/DiagnosticReport | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id} | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id}/_history | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/_history | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Encounter | 100 calls per hour | |||
| GET /fhir/Encounter/{id} | 100 calls per hour | |||
| GET /fhir/Encounter/{id}/_history | 100 calls per hour | |||
| GET /fhir/Encounter/_history | 100 calls per hour | |||
| GET /fhir/Encounter/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id} | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id}/_history | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/_history | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Goal | 100 calls per hour | |||
| GET /fhir/Goal/{id} | 100 calls per hour | |||
| GET /fhir/Goal/{id}/_history | 100 calls per hour | |||
| GET /fhir/Goal/_history | 100 calls per hour | |||
| GET /fhir/Goal/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Location | 100 calls per hour | |||
| GET /fhir/Location/{id} | 100 calls per hour | |||
| GET /fhir/Location/{id}/_history | 100 calls per hour | |||
| GET /fhir/Location/_history | 100 calls per hour | |||
| GET /fhir/Location/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Medication | 100 calls per hour | |||
| GET /fhir/Medication/{id} | 100 calls per hour | |||
| GET /fhir/Medication/{id}/_history | 100 calls per hour | |||
| GET /fhir/Medication/_history | 100 calls per hour | |||
| GET /fhir/Medication/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Organization | 100 calls per hour | |||
| GET /fhir/Organization/{id} | 100 calls per hour | |||
| GET /fhir/Organization/{id}/_history | 100 calls per hour | |||
| GET /fhir/Organization/_history | 100 calls per hour | |||
| GET /fhir/Organization/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Observation | 100 calls per hour | |||
| GET /fhir/Observation/{id} | 100 calls per hour | |||
| GET /fhir/Observation/{id}/_history | 100 calls per hour | |||
| GET /fhir/Observation/_history | 100 calls per hour | |||
| GET /fhir/Observation/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Patient | 100 calls per hour | |||
| GET /fhir/Patient/{id} | 100 calls per hour | |||
| GET /fhir/Patient/{id}/_history | 100 calls per hour | |||
| GET /fhir/Patient/_history | 100 calls per hour | |||
| GET /fhir/Patient/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Practitioner | 100 calls per hour | |||
| GET /fhir/Practitioner/{id} | 100 calls per hour | |||
| GET /fhir/Practitioner/{id}/_history | 100 calls per hour | |||
| GET /fhir/Practitioner/_history | 100 calls per hour | |||
| GET /fhir/Practitioner/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/PractitionerRole | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id} | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id}/_history | 100 calls per hour | |||
| GET /fhir/PractitionerRole/_history | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Procedure | 100 calls per hour | |||
| GET /fhir/Procedure/{id} | 100 calls per hour | |||
| GET /fhir/Procedure/{id}/_history | 100 calls per hour | |||
| GET /fhir/Procedure/_history | 100 calls per hour | |||
| GET /fhir/Procedure/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/RelatedPerson | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id} | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id}/_history | 100 calls per hour | |||
| GET /fhir/RelatedPerson/_history | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/ValueSet | 100 calls per hour | |||
| GET /fhir/ValueSet/{id} | 100 calls per hour | |||
| GET /fhir/ValueSet/{id}/_history | 100 calls per hour | |||
| GET /fhir/ValueSet/_history | 100 calls per hour | |||
| GET /fhir/ValueSet/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Endpoint | 100 calls per hour | |||
| GET /fhir/Endpoint/{id} | 100 calls per hour | |||
| GET /fhir/Endpoint/{id}/_history | 100 calls per hour | |||
| GET /fhir/Endpoint/_history | 100 calls per hour | |||
| GET /fhir/Endpoint/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/HealthcareService | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id} | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id}/_history | 100 calls per hour | |||
| GET /fhir/HealthcareService/_history | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/InsurancePlan | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id} | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id}/_history | 100 calls per hour | |||
| GET /fhir/InsurancePlan/_history | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Immunization | 100 calls per hour | |||
| GET /fhir/Immunization/{id} | 100 calls per hour | |||
| GET /fhir/Immunization/{id}/_history | 100 calls per hour | |||
| GET /fhir/Immunization/_history | 100 calls per hour | |||
| GET /fhir/Immunization/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id} | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id}/_history | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/_history | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id}/_history/{vid} | 100 calls per hour | |||
APIs
| Title | Version | Type | Rate limits | |
|---|---|---|---|---|
| FHIR Interoperability API | 1.0.0 | REST | 100 calls per hour | |
| GET /fhir/.well-known/smart-configuration | 100 calls per hour | |||
| GET /fhir/metadata | 100 calls per hour | |||
| GET /fhir/Patient/{id}/$everything | 100 calls per hour | |||
| GET /fhir/Condition | 100 calls per hour | |||
| GET /fhir/Condition/{id} | 100 calls per hour | |||
| GET /fhir/Condition/{id}/_history | 100 calls per hour | |||
| GET /fhir/Condition/_history | 100 calls per hour | |||
| GET /fhir/Condition/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Coverage | 100 calls per hour | |||
| GET /fhir/Coverage/{id} | 100 calls per hour | |||
| GET /fhir/Coverage/{id}/_history | 100 calls per hour | |||
| GET /fhir/Coverage/_history | 100 calls per hour | |||
| GET /fhir/Coverage/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/DiagnosticReport | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id} | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id}/_history | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/_history | 100 calls per hour | |||
| GET /fhir/DiagnosticReport/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Encounter | 100 calls per hour | |||
| GET /fhir/Encounter/{id} | 100 calls per hour | |||
| GET /fhir/Encounter/{id}/_history | 100 calls per hour | |||
| GET /fhir/Encounter/_history | 100 calls per hour | |||
| GET /fhir/Encounter/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id} | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id}/_history | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/_history | 100 calls per hour | |||
| GET /fhir/ExplanationOfBenefit/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Goal | 100 calls per hour | |||
| GET /fhir/Goal/{id} | 100 calls per hour | |||
| GET /fhir/Goal/{id}/_history | 100 calls per hour | |||
| GET /fhir/Goal/_history | 100 calls per hour | |||
| GET /fhir/Goal/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Location | 100 calls per hour | |||
| GET /fhir/Location/{id} | 100 calls per hour | |||
| GET /fhir/Location/{id}/_history | 100 calls per hour | |||
| GET /fhir/Location/_history | 100 calls per hour | |||
| GET /fhir/Location/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Medication | 100 calls per hour | |||
| GET /fhir/Medication/{id} | 100 calls per hour | |||
| GET /fhir/Medication/{id}/_history | 100 calls per hour | |||
| GET /fhir/Medication/_history | 100 calls per hour | |||
| GET /fhir/Medication/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Organization | 100 calls per hour | |||
| GET /fhir/Organization/{id} | 100 calls per hour | |||
| GET /fhir/Organization/{id}/_history | 100 calls per hour | |||
| GET /fhir/Organization/_history | 100 calls per hour | |||
| GET /fhir/Organization/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Observation | 100 calls per hour | |||
| GET /fhir/Observation/{id} | 100 calls per hour | |||
| GET /fhir/Observation/{id}/_history | 100 calls per hour | |||
| GET /fhir/Observation/_history | 100 calls per hour | |||
| GET /fhir/Observation/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Patient | 100 calls per hour | |||
| GET /fhir/Patient/{id} | 100 calls per hour | |||
| GET /fhir/Patient/{id}/_history | 100 calls per hour | |||
| GET /fhir/Patient/_history | 100 calls per hour | |||
| GET /fhir/Patient/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Practitioner | 100 calls per hour | |||
| GET /fhir/Practitioner/{id} | 100 calls per hour | |||
| GET /fhir/Practitioner/{id}/_history | 100 calls per hour | |||
| GET /fhir/Practitioner/_history | 100 calls per hour | |||
| GET /fhir/Practitioner/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/PractitionerRole | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id} | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id}/_history | 100 calls per hour | |||
| GET /fhir/PractitionerRole/_history | 100 calls per hour | |||
| GET /fhir/PractitionerRole/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Procedure | 100 calls per hour | |||
| GET /fhir/Procedure/{id} | 100 calls per hour | |||
| GET /fhir/Procedure/{id}/_history | 100 calls per hour | |||
| GET /fhir/Procedure/_history | 100 calls per hour | |||
| GET /fhir/Procedure/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/RelatedPerson | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id} | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id}/_history | 100 calls per hour | |||
| GET /fhir/RelatedPerson/_history | 100 calls per hour | |||
| GET /fhir/RelatedPerson/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/ValueSet | 100 calls per hour | |||
| GET /fhir/ValueSet/{id} | 100 calls per hour | |||
| GET /fhir/ValueSet/{id}/_history | 100 calls per hour | |||
| GET /fhir/ValueSet/_history | 100 calls per hour | |||
| GET /fhir/ValueSet/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Endpoint | 100 calls per hour | |||
| GET /fhir/Endpoint/{id} | 100 calls per hour | |||
| GET /fhir/Endpoint/{id}/_history | 100 calls per hour | |||
| GET /fhir/Endpoint/_history | 100 calls per hour | |||
| GET /fhir/Endpoint/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/HealthcareService | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id} | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id}/_history | 100 calls per hour | |||
| GET /fhir/HealthcareService/_history | 100 calls per hour | |||
| GET /fhir/HealthcareService/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/InsurancePlan | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id} | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id}/_history | 100 calls per hour | |||
| GET /fhir/InsurancePlan/_history | 100 calls per hour | |||
| GET /fhir/InsurancePlan/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/Immunization | 100 calls per hour | |||
| GET /fhir/Immunization/{id} | 100 calls per hour | |||
| GET /fhir/Immunization/{id}/_history | 100 calls per hour | |||
| GET /fhir/Immunization/_history | 100 calls per hour | |||
| GET /fhir/Immunization/{id}/_history/{vid} | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id} | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id}/_history | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/_history | 100 calls per hour | |||
| GET /fhir/OrganizationAffiliation/{id}/_history/{vid} | 100 calls per hour | |||