Standardized API for patient and population services
SMART on FHIR API is accessible on the host http://aidbox.cx360.net. It conforms to the following documents and specifications:
- § 170.215(a)(1) Health Level 7 (HL7®) Version 4.0.1 Fast Healthcare Interoperability Resources Specification (FHIR®) Release 4, October 30, 2019
- § 170.215(a)(2) FHIR® US Core Implementation Guide STU V3.1.1
- § 170.213 United States Core Data for Interoperability (USCDI)
- § 170.215(a)(1) HL7® Version 4.0.1 FHIR® Release 4, October 30, 2019
- § 170.215(a)(2) FHIR® US Core Implementation Guide STU V3.1.1
- § 170.213 USCDI
- § 170.215(a)(4) HL7® FHIR® Bulk Data Access (Flat FHIR®) (V1.0.1:STU 1)
- § 170.215(a)(2) FHIR® US Core Implementation Guide STU V3.1.1
- § 170.215(a)(4) HL7® FHIR® Bulk Data Access (Flat FHIR®) (V1.0.1:STU 1)
- § 170.215(a)(2) FHIR® US Core Implementation Guide STU V3.1.1
- § 170.215(a)(3) HL7® SMART Application Launch Framework Implementation Guide Release 1.0.0
- § 170.215(a)(4) HL7® FHIR® Bulk Data Access (Flat FHIR®) (V1.0.1:STU 1)
- § 170.215(a)(2) FHIR® US Core Implementation Guide STU V3.1.1
- § 170.215(a)(3) HL7® SMART Application Launch Framework Implementation Guide Release 1.0.0
- § 170.215(a)(4) HL7® FHIR® Bulk Data Access (Flat FHIR®) (V1.0.1:STU 1)
- § 170.215(a)(3) HL7® SMART Application Launch Framework Implementation Guide Release 1.0.0
- § 170.215(b) OpenID Connect Core 1.0 incorporating errata set 1
- § 170.215(a)(3) HL7® SMART Application Launch Framework Implementation Guide Release 1.0.0
- § 170.215(a)(4) HL7® FHIR® Bulk Data Access (Flat FHIR®) (V1.0.1:STU 1)
- Mandatory software components & configurations, technical requirements and attributes necessary for registration
US Core FHIR Endpoints
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- user/AllergyIntolerance.read
- patient/AllergyIntolerance.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- clinical-status all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- user/AllergyIntolerance.read
- patient/AllergyIntolerance.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- clinical-status all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- user/AllergyIntolerance.read
- patient/AllergyIntolerance.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- patient/CarePlan.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- patient/CarePlan.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- patient/CarePlan.read
- user/*.read
- patient/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- patient/CareTeam.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- role all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- patient/CareTeam.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- role all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- patient/CareTeam.read
- user/*.read
- patient/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Condition.read
- user/Condition.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- clinical-status all values are supported
- code all values are supported
- onset-date all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Condition.read
- user/Condition.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- clinical-status all values are supported
- code all values are supported
- onset-date all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Condition.read
- user/Condition.read
- user/*.read
- patient/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Device.read
- user/*.read
- patient/*.read
- user/Device.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Device.read
- user/*.read
- patient/*.read
- user/Device.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Device.read
- user/*.read
- patient/*.read
- user/Device.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
- patient/DiagnosticReport.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
- patient/DiagnosticReport.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
- patient/DiagnosticReport.read
- patient/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- patient/DocumentReference.read
- user/DocumentReference.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- period all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- patient/DocumentReference.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- patient/DocumentReference.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- patient/DocumentReference.read
- user/DocumentReference.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- period all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/*.read
- patient/DocumentReference.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Encounter.read
- user/*.read
- patient/*.read
- user/Encounter.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- class all values are supported
- date all values are supported
- discharge-disposition all values are supported
- identifier all values are supported
- location all values are supported
- patient all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Encounter.read
- user/*.read
- patient/*.read
- user/Encounter.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- class all values are supported
- date all values are supported
- discharge-disposition all values are supported
- identifier all values are supported
- location all values are supported
- patient all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Encounter.read
- user/*.read
- patient/*.read
- user/Encounter.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
- patient/*.read
- patient/Goal.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- description all values are supported
- lifecycle-status all values are supported
- patient all values are supported
- target-date all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
- patient/*.read
- patient/Goal.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- description all values are supported
- lifecycle-status all values are supported
- patient all values are supported
- target-date all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
- patient/*.read
- patient/Goal.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
- patient/*.read
- patient/Immunization.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
- patient/*.read
- patient/Immunization.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
- patient/*.read
- patient/Immunization.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/Location.read
- patient/*.read
- user/Location.read
Search parameters
Allowed:
- _count all values are supported
- address all values are supported
- address-city all values are supported
- address-postalcode all values are supported
- address-state all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/Location.read
- patient/*.read
- user/Location.read
Search parameters
Allowed:
- _count all values are supported
- address all values are supported
- address-city all values are supported
- address-postalcode all values are supported
- address-state all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- patient/Location.read
- patient/*.read
- user/Location.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
- patient/*.read
- patient/MedicationRequest.read
Search parameters
Allowed:
- _count all values are supported
- _include supported values:
- MedicationRequest:medication
- _revinclude supported values:
- Provenance:target
- authoredon all values are supported
- encounter all values are supported
- intent all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
- patient/*.read
- patient/MedicationRequest.read
Search parameters
Allowed:
- _count all values are supported
- _include supported values:
- MedicationRequest:medication
- _revinclude supported values:
- Provenance:target
- authoredon all values are supported
- encounter all values are supported
- intent all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
- patient/*.read
- patient/MedicationRequest.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Observation.read
- user/*.read
- patient/*.read
- user/Observation.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Observation.read
- user/*.read
- patient/*.read
- user/Observation.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Observation.read
- user/*.read
- patient/*.read
- user/Observation.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
- patient/*.read
- patient/Organization.read
Search parameters
Allowed:
- _count all values are supported
- address all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
- patient/*.read
- patient/Organization.read
Search parameters
Allowed:
- _count all values are supported
- address all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
- patient/*.read
- patient/Organization.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Patient.read
- user/*.read
- patient/*.read
- user/Patient.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- birthdate all values are supported
- family all values are supported
- gender all values are supported
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Patient.read
- user/*.read
- patient/*.read
- user/Patient.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- birthdate all values are supported
- family all values are supported
- gender all values are supported
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Patient.read
- user/*.read
- patient/*.read
- user/Patient.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Practitioner.read
- user/*.read
- patient/*.read
- user/Practitioner.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Practitioner.read
- user/*.read
- patient/*.read
- user/Practitioner.read
Search parameters
Allowed:
- _count all values are supported
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Practitioner.read
- user/*.read
- patient/*.read
- user/Practitioner.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Procedure.read
- user/Procedure.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- patient/Procedure.read
- user/Procedure.read
- user/*.read
- patient/*.read
Search parameters
Allowed:
- _count all values are supported
- _revinclude supported values:
- Provenance:target
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- patient/Procedure.read
- user/Procedure.read
- user/*.read
- patient/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
- patient/*.read
- patient/Provenance.read
Search parameters
Allowed:
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
- patient/*.read
- patient/Provenance.read
Search parameters
Allowed:
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
- patient/*.read
- patient/Provenance.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Get Authorization Server Metadata
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
EHR’s style parameters can be retrieved
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/AllergyIntolerance.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- clinical-status all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/AllergyIntolerance.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- clinical-status all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/AllergyIntolerance.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/CarePlan.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- role all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- role all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/CareTeam.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Condition.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- clinical-status all values are supported
- code all values are supported
- onset-date all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Condition.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- clinical-status all values are supported
- code all values are supported
- onset-date all values are supported
- patient all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Condition.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Device.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Device.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- patient all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Device.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/DiagnosticReport.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/DocumentReference.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- period all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/DocumentReference.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- category all values are supported
- date all values are supported
- patient all values are supported
- period all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/DocumentReference.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Encounter.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- class all values are supported
- date all values are supported
- discharge-disposition all values are supported
- identifier all values are supported
- location all values are supported
- patient all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Encounter.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- class all values are supported
- date all values are supported
- discharge-disposition all values are supported
- identifier all values are supported
- location all values are supported
- patient all values are supported
- status all values are supported
- type all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Encounter.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- description all values are supported
- lifecycle-status all values are supported
- patient all values are supported
- target-date all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- description all values are supported
- lifecycle-status all values are supported
- patient all values are supported
- target-date all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Goal.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Immunization.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Location.read
Search parameters
Allowed:
- address all values are supported
- address-city all values are supported
- address-postalcode all values are supported
- address-state all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Location.read
Search parameters
Allowed:
- address all values are supported
- address-city all values are supported
- address-postalcode all values are supported
- address-state all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Location.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
Search parameters
Allowed:
- _include supported values:
- MedicationRequest:medication
- _revinclude supported values:
- Provenance:target
- authoredon all values are supported
- encounter all values are supported
- intent all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
Search parameters
Allowed:
- _include supported values:
- MedicationRequest:medication
- _revinclude supported values:
- Provenance:target
- authoredon all values are supported
- encounter all values are supported
- intent all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/MedicationRequest.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Observation.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Observation.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- category all values are supported
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Observation.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
Search parameters
Allowed:
- address all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
Search parameters
Allowed:
- address all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Organization.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Patient.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- birthdate all values are supported
- family all values are supported
- gender all values are supported
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Patient.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- birthdate all values are supported
- family all values are supported
- gender all values are supported
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Patient.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Practitioner.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Practitioner.read
Search parameters
Allowed:
- _id all values are supported
- _revinclude supported values:
- Provenance:target
- identifier all values are supported
- name all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/*.read
- user/Practitioner.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Procedure.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Procedure.read
- user/*.read
Search parameters
Allowed:
- _revinclude supported values:
- Provenance:target
- code all values are supported
- date all values are supported
- patient all values are supported
- status all values are supported
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Procedure.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
Search parameters
Allowed:
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
Search parameters
Allowed:
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
- user/Provenance.read
- user/*.read
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
- 401
{ "resourceType" : "OperationOutcome", "id" : "login", "text" : { "status" : "generated", "div" : "Unauthorized" }, "issue" : [ { "severity" : "fatal", "code" : "login", "diagnostics" : "Unauthorized" } ] }
- 403
{ "resourceType" : "OperationOutcome", "id" : "forbidden", "text" : { "status" : "generated", "div" : "Forbidden" }, "issue" : [ { "severity" : "fatal", "code" : "forbidden", "diagnostics" : "Forbidden" } ] }
Description
Get Authorization Server Metadata
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
EHR’s style parameters can be retrieved
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Supporting Standardized API Endpoints
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
SMART configuration metadata, including OAuth authorization_endpoint and token_endpoint URLs
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
SMART configuration metadata, including OAuth authorization_endpoint and token_endpoint URLs
Responses
- 200 Result according to the FHIR specification: https://www.hl7.org/fhir/