Get a Demo

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/

C-CDA API: Application access - all data request

Description

The C-CDA API returns a Continuity of Care Document (CCD) formatted in accordance with the C-CDA version 2.1 specification and the USCDI v1 list.

Supported C-CDA Sections

SectionGiven date range applies
Allergies and IntolerancesNo
MedicationsNo
ProblemsNo
GoalsNo
ResultsYes
Social HistoryNo
Vital SignsYes
EncountersYes
Functional StatusNo
ImmunizationsNo
Medical EquipmentNo
Mental StatusNo
PayersNo
ProceduresYes
Hospital CourseNo
AssessmentsNo
Procedure NotesYes
History And Physical NotesYes
Consultation NotesYes
Progress NotesYes
Plan of treatmentNo
Health ConcernsNo
Laboratory NotesYes
Discharge InstructionsNo
Discharge SummaryNo
Example
GET /tenant/{tenant}/ccda/make-doc?docdef-id=continuity-of-care&pid=amb1&start-date=2015-06-22&end-date=2015-06-25&filename=amb1.xml
Parameters
  • docdef-id Type of the document being generated. The only allowed value is continuity-of-care
  • pid Patient ID
  • start-date, end-date Specifies date range for generated document. Both parameters can be ommited to generate C-CDA document for the entire care period. The date filtering logic is described by the FHIR date search param.
  • filename If present, the generated document will be saved to the user's Downloads folder instead of displayed in the browser.
Responses
  • 200 Generated XML document with the application/cda+xml content-type header.
  • non-200 OperationOutcome resource with exception description according to the FHIR Specification.

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/

§170.315(b)(10) Electronic Health Information export

To comply with this requirement of the §170.315(b)(10) criteria, Aidbox FHIR API module supports FHIR Bulk Data Export specification. The full Bulk Data Export feature documentation can be found on its documentation page.

Output file format

By default, Bulk Data Export files adhere to the NDJSON (Newline Delimited JSON) format, which is a modified version of JSON optimized for the efficient transfer of large amounts of data. This formatting approach streamlines data processing by ensuring that each NDJSON document refers to resources of a single type. Within the document, each row corresponds to a resource of that specific type. While a single file may contain numerous resources related to different patients and their records, the resource type remains consistent throughout all entries within the file.

Including resources

During the resource export process, all data contained within the Patient comparment, as outlined by HL7. This entails that all patient-related information, including demographics, observations, medications, and additional healthcare data, will constitute components of the exported resources.

Patient-level export / 170.315(b)(10)(i)

Aidbox FHIR API module provides an exporting functionality designed to retrieve data associated with an individual patient.

To start patient-level export, make an HTTP request:

GET /fhir/Patient/$export
Accept: application/fhir+json
Prefer: respond-async

Parameters

_outputFormat

Specifies format in which the server generates files. The following formats are supported:

  • application/fhir+ndjson
  • application/fhir+ndjson+gzip
_type

Includes only the specified resource types. This list is a comma-separated string.

_since

Includes only resources changed after the specified time.

patient

Export data that belongs only to listed patients. Format: comma-separated list of patient ids.

Group-level export / 170.315(b)(10)(ii)

To comply with group-level export criteria, Aidbox FHIR API module provides exporting patients and their correlated data.

To start group-level export, make an HTTP request:

GET /fhir/Group//$export
Accept: application/fhir+json
Prefer: respond-async

Parameters

_outputFormat

Specifies format in which the server generates files. The following formats are supported:

  • application/fhir+ndjson
  • application/fhir+ndjson+gzip
_type

Includes only the specified resource types. This list is a comma-separated string.

_since

Includes only resources changed after the specified time.

Access control

To start exporting data, a system administrator user making the HTTP request should be allowed to perform such operations. Otherwise, the request will fail with an "Unauthorized" response.