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:

US Core FHIR Endpoints

Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • user/AllergyIntolerance.read
  • patient/AllergyIntolerance.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • user/AllergyIntolerance.read
  • patient/AllergyIntolerance.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/CarePlan.read
  • patient/CarePlan.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/CarePlan.read
  • patient/CarePlan.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/CareTeam.read
  • patient/CareTeam.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/CareTeam.read
  • patient/CareTeam.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Condition.read
  • user/Condition.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Condition.read
  • user/Condition.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Device.read
  • user/*.read
  • patient/*.read
  • user/Device.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Device.read
  • user/*.read
  • patient/*.read
  • user/Device.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/DiagnosticReport.read
  • user/*.read
  • patient/DiagnosticReport.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/DiagnosticReport.read
  • user/*.read
  • patient/DiagnosticReport.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Search parameters
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"
      } ]
    }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Search parameters
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Encounter.read
  • user/*.read
  • patient/*.read
  • user/Encounter.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Encounter.read
  • user/*.read
  • patient/*.read
  • user/Encounter.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Goal.read
  • user/*.read
  • patient/*.read
  • patient/Goal.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Goal.read
  • user/*.read
  • patient/*.read
  • patient/Goal.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Immunization.read
  • user/*.read
  • patient/*.read
  • patient/Immunization.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Immunization.read
  • user/*.read
  • patient/*.read
  • patient/Immunization.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/Location.read
  • patient/*.read
  • user/Location.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/Location.read
  • patient/*.read
  • user/Location.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/MedicationRequest.read
  • user/*.read
  • patient/*.read
  • patient/MedicationRequest.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/MedicationRequest.read
  • user/*.read
  • patient/*.read
  • patient/MedicationRequest.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Observation.read
  • user/*.read
  • patient/*.read
  • user/Observation.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Observation.read
  • user/*.read
  • patient/*.read
  • user/Observation.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Organization.read
  • user/*.read
  • patient/*.read
  • patient/Organization.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Organization.read
  • user/*.read
  • patient/*.read
  • patient/Organization.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Patient.read
  • user/*.read
  • patient/*.read
  • user/Patient.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Patient.read
  • user/*.read
  • patient/*.read
  • user/Patient.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Practitioner.read
  • user/*.read
  • patient/*.read
  • user/Practitioner.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Practitioner.read
  • user/*.read
  • patient/*.read
  • user/Practitioner.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Procedure.read
  • user/Procedure.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Procedure.read
  • user/Procedure.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Provenance.read
  • user/*.read
  • patient/*.read
  • patient/Provenance.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
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"
      } ]
    }
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
EHR’s style parameters can be retrieved
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/

Supporting Standardized API Endpoints

Description
Creating a demo user
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Smart API documentation
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Demo user page
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Demo user auth
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Log out a demo user
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Service base URLs list
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
SMART configuration metadata, including OAuth authorization_endpoint and token_endpoint URLs
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • user/AllergyIntolerance.read
  • patient/AllergyIntolerance.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/CarePlan.read
  • patient/CarePlan.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/CarePlan.read
  • patient/CarePlan.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/CareTeam.read
  • patient/CareTeam.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/CareTeam.read
  • patient/CareTeam.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Condition.read
  • user/Condition.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Condition.read
  • user/Condition.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Device.read
  • user/*.read
  • patient/*.read
  • user/Device.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Device.read
  • user/*.read
  • patient/*.read
  • user/Device.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/DiagnosticReport.read
  • user/*.read
  • patient/DiagnosticReport.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/DiagnosticReport.read
  • user/*.read
  • patient/DiagnosticReport.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Search parameters
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"
      } ]
    }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
This operation is used to return all the references to documents related to a patient
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Search parameters
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/*.read
  • patient/DocumentReference.read
  • user/DocumentReference.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Encounter.read
  • user/*.read
  • patient/*.read
  • user/Encounter.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Encounter.read
  • user/*.read
  • patient/*.read
  • user/Encounter.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Goal.read
  • user/*.read
  • patient/*.read
  • patient/Goal.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Goal.read
  • user/*.read
  • patient/*.read
  • patient/Goal.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Immunization.read
  • user/*.read
  • patient/*.read
  • patient/Immunization.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Immunization.read
  • user/*.read
  • patient/*.read
  • patient/Immunization.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/Location.read
  • patient/*.read
  • user/Location.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/*.read
  • patient/Location.read
  • patient/*.read
  • user/Location.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/MedicationRequest.read
  • user/*.read
  • patient/*.read
  • patient/MedicationRequest.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/MedicationRequest.read
  • user/*.read
  • patient/*.read
  • patient/MedicationRequest.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Observation.read
  • user/*.read
  • patient/*.read
  • user/Observation.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Observation.read
  • user/*.read
  • patient/*.read
  • user/Observation.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Organization.read
  • user/*.read
  • patient/*.read
  • patient/Organization.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • user/Organization.read
  • user/*.read
  • patient/*.read
  • patient/Organization.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Patient.read
  • user/*.read
  • patient/*.read
  • user/Patient.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Patient.read
  • user/*.read
  • patient/*.read
  • user/Patient.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Practitioner.read
  • user/*.read
  • patient/*.read
  • user/Practitioner.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Practitioner.read
  • user/*.read
  • patient/*.read
  • user/Practitioner.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • patient/Procedure.read
  • user/Procedure.read
  • user/*.read
  • patient/*.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
Description
Reads the current state of a resource. See documentation at: https://www.hl7.org/fhir/http.html#read
Scope
Operation is allowed when one of the following scope:
  • patient/Procedure.read
  • user/Procedure.read
  • user/*.read
  • patient/*.read
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
  • 401
    {
      "resourceType" : "OperationOutcome",
      "id" : "login",
      "text" : {
        "status" : "generated",
        "div" : "Unauthorized"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "login",
        "diagnostics" : "Unauthorized"
      } ]
    }
  • 403
    {
      "resourceType" : "OperationOutcome",
      "id" : "forbidden",
      "text" : {
        "status" : "generated",
        "div" : "Forbidden"
      },
      "issue" : [ {
        "severity" : "fatal",
        "code" : "forbidden",
        "diagnostics" : "Forbidden"
      } ]
    }
Description
Search the resource based on some filter criteria. See documentation at: https://www.hl7.org/fhir/http.html#search
Scope
Operation is allowed when one of the following scope:
  • user/Provenance.read
  • user/*.read
  • patient/*.read
  • patient/Provenance.read
Search parameters
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"
      } ]
    }
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"
      } ]
    }
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"
      } ]
    }
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
Get Authorization Server Metadata
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Description
EHR’s style parameters can be retrieved
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Search parameters
All parameters are allowed with all the values
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/
Responses
  • 200 Result according to the FHIR specification: https://www.hl7.org/fhir/