Standardized API for patient and population services

SMART on FHIR API is accessible on the host https://cmpl.aidbox.app. 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

GET/tenant/{tenant}/smart-api/AllergyIntolerance

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/AllergyIntolerance/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/AllergyIntolerance/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/CarePlan

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/CarePlan/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/CarePlan/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/CareTeam

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/CareTeam/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/CareTeam/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Condition

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Condition/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Condition/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Device

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Device/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Device/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/DiagnosticReport

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/DiagnosticReport/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/DiagnosticReport/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/DocumentReference

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/DocumentReference/$docref

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"
  } ]
}

POST/tenant/{tenant}/smart-api/DocumentReference/$docref

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"
  } ]
}

POST/tenant/{tenant}/smart-api/DocumentReference/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/DocumentReference/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Encounter

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Encounter/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Encounter/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Goal

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Goal/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Goal/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Immunization

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Immunization/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Immunization/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Location

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Location/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Location/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/MedicationRequest

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/MedicationRequest/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/MedicationRequest/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Observation

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Observation/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Observation/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Organization

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Organization/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Organization/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Patient

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Patient/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Patient/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Practitioner

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Practitioner/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Practitioner/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Procedure

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Procedure/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Procedure/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Provenance

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

All parameters are allowed with all the values

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"
  } ]
}

POST/tenant/{tenant}/smart-api/Provenance/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/tenant/{tenant}/smart-api/Provenance/{id}

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"
  } ]
}

GET/tenant/{tenant}/smart-api/metadata

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/smart-api/style-v1.json

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

GET/

Description

Creating a demo user

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/admin/portal

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/$export-status/{bulk-export-id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

DELETE/bulk/$export-status/{bulk-export-id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/$redirect

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/Group

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/Group/{id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/Group/{id}/$export

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/bulk/metadata

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/documentation

Description

Smart API documentation

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/inferno

Description

Demo user page

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

POST/inferno/create-demo-user

Description

Demo user auth

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/inferno/logout

Description

Log out a demo user

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart

Description

Service base URLs list

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart-auth/grant

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/.well-known/smart-configuration

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/

GET/smart/AllergyIntolerance

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/AllergyIntolerance/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/AllergyIntolerance/{id}

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"
  } ]
}

GET/smart/CarePlan

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/CarePlan/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/CarePlan/{id}

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"
  } ]
}

GET/smart/CareTeam

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/CareTeam/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/CareTeam/{id}

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"
  } ]
}

GET/smart/Condition

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Condition/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Condition/{id}

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"
  } ]
}

GET/smart/Device

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Device/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Device/{id}

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"
  } ]
}

GET/smart/DiagnosticReport

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/DiagnosticReport/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/DiagnosticReport/{id}

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"
  } ]
}

GET/smart/DocumentReference

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/DocumentReference/$docref

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"
  } ]
}

POST/smart/DocumentReference/$docref

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"
  } ]
}

POST/smart/DocumentReference/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/DocumentReference/{id}

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"
  } ]
}

GET/smart/Encounter

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Encounter/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Encounter/{id}

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"
  } ]
}

GET/smart/Goal

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Goal/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Goal/{id}

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"
  } ]
}

GET/smart/Immunization

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Immunization/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Immunization/{id}

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"
  } ]
}

GET/smart/Location

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Location/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Location/{id}

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"
  } ]
}

GET/smart/MedicationRequest

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/MedicationRequest/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/MedicationRequest/{id}

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"
  } ]
}

GET/smart/Observation

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Observation/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Observation/{id}

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"
  } ]
}

GET/smart/Organization

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Organization/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Organization/{id}

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"
  } ]
}

GET/smart/Patient

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Patient/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Patient/{id}

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"
  } ]
}

GET/smart/Practitioner

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Practitioner/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Practitioner/{id}

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"
  } ]
}

GET/smart/Procedure

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Procedure/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Procedure/{id}

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"
  } ]
}

GET/smart/Provenance

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

All parameters are allowed with all the values

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"
  } ]
}

POST/smart/Provenance/_search

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

All parameters are allowed with all the values

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"
  } ]
}

GET/smart/Provenance/{id}

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"
  } ]
}

GET/smart/api

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/demo/login

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/demo/profile

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/metadata

Description

Get Authorization Server Metadata

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/style-v1.json

Description

EHR’s style parameters can be retrieved

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/smart/ui

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/$export-status/{bulk-export-id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

DELETE/tenant/bulk-api/$export-status/{bulk-export-id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/$redirect

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/Group

Search parameters

All parameters are allowed with all the values

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/Group/{id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/Group/{id}/$export

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/bulk-api/metadata

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/authorize

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

POST/tenant/{tenant}/auth/grant

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/grant

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/grants

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

DELETE/tenant/{tenant}/auth/grants/{id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/login

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

POST/tenant/{tenant}/auth/login

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

POST/tenant/{tenant}/auth/logout

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/sessions

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

DELETE/tenant/{tenant}/auth/sessions/{id}

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/smart-apps

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/two-factor

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/auth/userinfo

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/patient-portal

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

POST/tenant/{tenant}/rpc

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/

GET/tenant/{tenant}/smart-api/.well-known/smart-configuration

Responses

200 Result according to the FHIR specification: https://www.hl7.org/fhir/