apotti-eko01
type: CapabilityStatement
node role: treeRoot
text:
  status:
    v: extensions
  div: Generated Narrative: CapabilityStatement apotti-eko01 Implementation Guide Version: 2.0.0-rc2 FHIR Version: 4.0.1 Supported Formats: xml, json Supported Patch Formats: Published on: 2023-07-04 12:16:44+0000 Published by: HL7 Finland ry Note to Implementers: FHIR Capabilities Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case. This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data FHIR RESTful Capabilities Mode: server Security Enable CORS: yes Security services supported: OAuth, SMART-on-FHIR, Basic Summary of System-wide Interactions Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R S U C Searches _include _revinclude Operations AdverseEvent y y seriousness, study, subject, _id, _count * Provenance:target AllergyIntolerance y y y clinical-status, patient, _id, _count * Provenance:target Appointment y y date, identifier, patient, service-category, status, _id, _count * Provenance:target Binary y BodyStructure y y location, morphology, patient, subject, _id, _count * Provenance:target CarePlan y y activity-date, category, encounter, patient, part-of, status, subject, _id, _count * Provenance:target CareTeam y y patient, status, subject, _id, _count * Provenance:target Co…
url:
  v: https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apotti-eko01
version:
  v: 2.0.0-rc2
name:
  v: CapabilityStatementExampleApotti
status:
  v: active
experimental:
  v: true
date:
  v: 2023-07-04T12:16:44Z
publisher:
  v: HL7 Finland ry
contact:
  name:
    v: HL7 Finland ry
  telecom:
    system:
      v: url
    value:
      v: https://www.hl7.fi/
  telecom:
    system:
      v: email
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: FI
    display:
      v: Finland
copyright:
  v: Copyright Epic 1979-2022
kind:
  v: instance
instantiates:
  v: http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data
  link: http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data
software:
  name:
    v: Epic
  version:
    v: marraskuu 2022
  release date:
    v: 2023-03-13
implementation:
  description:
    v: Apotti EKO01 FHIR Server
  url:
    v: https://gw.apottiekosysteemi.fi/Interconnect-FHIR-EKO01/api/FHIR/R4
fhir version:
  v: 4.0.1
format:
  v: xml
format:
  v: json
rest:
  mode:
    v: server
  security:
    extension:
      extension:
        value: uri
      extension:
        value: uri
      url:
        v: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
    cors:
      v: true
    service:
      text:
        v: OAuth
    service:
      text:
        v: SMART-on-FHIR
    service:
      text:
        v: Basic
  resource:
    type:
      v: AdverseEvent
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
    read history:
      v: false
    update create:
      v: false
    conditional create:
      v: false
    conditional read:
      v: not-supported
    conditional update:
      v: false
    conditional delete:
      v: not-supported
    search include:
      v: *
    search rev include:
      v: Provenance:target
    search param:
      name:
        v: seriousness
      type:
        v: token
      documentation:
        v: Refine a search for AdverseEvent resources by seriousness of the event. Serious and Non-serious are the only supported values.
    search param:
      name:
        v: study
      type:
        v: reference
      documentation:
        v: Search for AdverseEvent resources for a specified study ID.
    search param:
      name:
        v: subject
      type:
        v: reference
      documentation:
        v: Search for AdverseEvent resources for a specified patient ID.
    search param:
      name:
        v: _id
      type:
        v: token
      documentation:
        v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
    search param:
      name:
        v: _count
      type:
        v: number
      documentation:
        v: Number of results per page.
  resource:
    type:
      v: AllergyIntolerance
    interaction:
      code:
        v: create
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
    read history:
      v: false
    update create:
      v: false
    conditional create:
      v: false
    conditional read:
      v: not-supported
    conditional update:
      v: false
    conditional delete:
      v: not-supported
    search include:
      v: *
    search rev include:
      v: Provenance:target
    search param:
      name:
        v: clinical-status
      type:
        v: token
      documentation:
        v: Refine a search for AllergyIntolerance resources by clinicalStatus. Active is the only supported clinical status to search by.
    search param:
      name:
        v: patient
      type:
        v: reference
      documentation:
        v: Search for AllergyIntolerance resources for a specified patient ID.
    search param:
      name:
        v: _id
      type:
        v: token
      documentation:
        v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
    search param:
      name:
        v: _count
      type:
        v: number
      documentation:
        v: Number of results per page.

v: authorize

v: token

v: OAuth

v: OAuth

v: SMART-on-FHIR

v: SMART-on-FHIR

v: Basic

v: Basic

type:
  v: Appointment
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for Appointment resources by date. By default, all Appointments are returned. Not supported for scheduled surgeries.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Refine a search for Appointment resources by identifier. Not supported for scheduled surgeries.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Appointment resources for a specified patient ID.
search param:
  name:
    v: service-category
  type:
    v: token
  documentation:
    v: Search on the type of appointment. Enter 'surgery' for scheduled surgery appointments, and 'appointment' for all other types of appointments.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for Appointment resources by status. By default, all Appointments are returned. Not supported for scheduled surgeries.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Binary
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: BodyStructure
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: location
  type:
    v: token
  documentation:
    v: Refine a search for BodyStructure resources by identifier. Enter using the structure "[system]|[search string]".
search param:
  name:
    v: morphology
  type:
    v: token
  documentation:
    v: Refine a search for BodyStructure resources by morphology.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for BodyStructure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for BodyStructure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: CarePlan
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: activity-date
  type:
    v: date
  documentation:
    v: Search for CarePlan resources with questionaires due before the provided date.
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Search for CarePlans of the given type. This is a required search parameter.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Refine a search for Encounter CarePlans to search only the encounters provided. Ignored if not searching for Encounter CarePlans.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for CarePlan resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: part-of
  type:
    v: reference
  documentation:
    v: Refine a search for Education CarePlans to include only Education CarePlans that are part of the given Education CarePlans. Ignored if not searching for Education CarePlans.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for Encounter, Education, and Care Path CarePlans to search only for encounters, education, or Care Paths with the provided status. Ignored if not searching for Encounter, Education, or Care Path CarePlans.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for CarePlan resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: CareTeam
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for CareTeam resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search based on the CareTeam's status. Currently only active is supported.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for CareTeam resources using a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Communication
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: based-on
  type:
    v: reference
  documentation:
    v: Refine a search for Education Communication resources to include only Education Communication resources that are documentation for the given Education CarePlans. These should be CarePlans with an education-subcategory of point. Ignored if not searching for Education Communication resources.
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search to include only Communication resources with the given categories.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Refine a search to include Communication resources from only the encounters provided.
search param:
  name:
    v: part-of
  type:
    v: reference
  documentation:
    v: Refine a search for Communication resources "part of" a specified Task ID. If not provided, all Communications are returned.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Communication resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Communication resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ConceptMap
interaction:
  code:
    v: create
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: Condition
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: abatement-date
  type:
    v: date
  documentation:
    v: Search for Conditions with a specified abatement date. This is only used when searching for infections.
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Search for Condition resources by category.
search param:
  name:
    v: clinical-status
  type:
    v: token
  documentation:
    v: Refine a search for Condition resources by clinicalStatus. Only clinical statuses of 'inactive', 'resolved' and 'active' are supported for health concerns and problem list items. Only clinical statuses of 'inactive' and 'active' are supported for infections.
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Search for Conditions with a specified code. This is only used when searching for infections.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for Condition resources for specific encounters.
search param:
  name:
    v: onset-date
  type:
    v: date
  documentation:
    v: Search for Conditions with a specified onset date. This is only used when searching for infections.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Condition resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: recorded-date
  type:
    v: date
  documentation:
    v: Search for Conditions with a specified recorded date. This is only used when searching for infections.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Condition resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Consent
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Search for Consent resources by category.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Consent resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Search for Consent resources by status.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Consent resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Coverage
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: beneficiary
  type:
    v: reference
  documentation:
    v: Search for Coverage resource for a specific patient ID. You can use "patient" or "beneficiary" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Coverage resource for a specific patient ID. You can use "patient" or "beneficiary" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Device
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: device-name
  type:
    v: string
  documentation:
    v: A string that will match the Device.deviceName.name field. Not case sensitive.
search param:
  name:
    v: manufacturer
  type:
    v: string
  documentation:
    v: Manufacturer of the device.
search param:
  name:
    v: model
  type:
    v: string
  documentation:
    v: Model number of the device.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: The patient in whom this device is implanted. This is a required parameter.
search param:
  name:
    v: udi-carrier
  type:
    v: string
  documentation:
    v: The UDI barcode string - matches static UDI.
search param:
  name:
    v: udi-di
  type:
    v: string
  documentation:
    v: The UDI device identifier (DI).
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: DeviceRequest
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for DeviceRequest resource for a specified patient ID.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Search for a DeviceRequest based on a device request status
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: DeviceUseStatement
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for DeviceUseStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for DeviceUseStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: DiagnosticReport
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
interaction:
  code:
    v: update
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for DiagnosticReport resources by category.
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Refine a search for DiagnosticReport resources by code.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for DiagnosticReport resources by specifying a date or date range that a DiagnosticReport was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. Not supported by Care Plan Goal.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Refine search by specifying an identifier, such as the internal order ID or the accession number. Not supported by Care Plan Goal.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for DiagnosticReport resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for DiagnosticReport resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: DocumentReference
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
interaction:
  code:
    v: update
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: author
  type:
    v: reference
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a Practitioner ID that corresponds to the author of the document. Currently only supported for correspondence and imaging-result search.
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for DocumentReference resources by category.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]) that corresponds to the document creation time. Local server time is assumed if time zone information is not included.
search param:
  name:
    v: docstatus
  type:
    v: token
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a docStatus. By default, all docStatuses are returned. Not supported for correspondence, imaging-result, or questionnaire-response search.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for DocumentReference resources for a specified encounter ID. Not supported for correspondence, imaging-result, or questionnaire-response search.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for DocumentReference resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: period
  type:
    v: date
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the time of the service that is being documented. Not supported for questionnaire-response search.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a status of the document. Currently only supported for questionnaire-response with a status of current.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for DocumentReference resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: type
  type:
    v: token
  documentation:
    v: Further refine a search for a given set of DocumentReferences on a patient by specifying a type code to return only documents of that type. Use the format: type= to search all supported systems with that code or type=<system>| to further refine the search to one code system. Not supported for questionnaire-response search.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Encounter
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: class
  type:
    v: token
  documentation:
    v: Refine a search for Encounter resources by class. By default, all classes are returned.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for Encounter resources by date. By default, all Encounters are returned. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]). Local server time is assumed if time zone information is not included.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Search for Encounter resources by encounter identifier in the format |
search param:
  name:
    v: onlyscannable
  type:
    v: token
  documentation:
    v: Refine a search for Encounter resources to scannable encounters only. By default, all Encounters are returned. Use a value of "true" to only return scannable encounters. Can only be used when the application is launched from Hyperspace.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Encounter resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Encounter resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Endpoint
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: EpisodeOfCare
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for EpisodeOfCare resources for a specified patient ID.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for EpisodeOfCare resources by status. Active, finished, and cancelled are the only supported statuses.
search param:
  name:
    v: type
  type:
    v: token
  documentation:
    v: Refine a search for EpisodeOfCare resources by type.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ExplanationOfBenefit
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: created
  type:
    v: date
  documentation:
    v: Refine a search for ExplanationOfBenefit resources by creation date for the claim. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for ExplanationOfBenefit resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: FamilyMemberHistory
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Required: the patient whose family history you'd like to search.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Flag
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Flag resources by category.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Refine a search for Flag resources by encounter. This is currently only supported for the isolation category.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Flag resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for Flag resources by status.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Flag resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Goal
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refines a search by Goal category.
search param:
  name:
    v: lifecycle-status
  type:
    v: token
  documentation:
    v: Refines a search based on Goal lifecycle status.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Patient resources for a specific patient ID. You can use "patient" or "subject" equivalently but they can't be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Patient resources for a specific patient ID. You can use "patient" or "subject" equivalently but they can't be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Group
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.
operation:
  name:
    v: group-export
  definition:
    v: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export
    link: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export

type:
  v: ImagingStudy
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Search for ImagingStudy resources by a study's identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. An ImagingStudy's identifier must be in the format | or <ID Type>|<ID>.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for ImagingStudy resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for ImagingStudy resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Immunization
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for Immunization resources by vaccine administration date. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Immunization resources for a specified patient ID.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for Immunization resources by status.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ImmunizationRecommendation
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: The FHIR id of a patient whose immunization recommendations you'd like to obtain. Only one of either patient or subject needs to be specified.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: List
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Refine a search for List resources by list type. Accepted values include "medications," "allergies," "immunizations," "problems," "pedigree-list," and "hospital-problems."
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Refine a search for List resources by encounter.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Location
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Measure
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: MeasureReport
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Medication
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: MedicationAdministration
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: context
  type:
    v: reference
  documentation:
    v: Refine a search for MedicationAdministration resources with one or more linked encounters.
search param:
  name:
    v: effective-time
  type:
    v: date
  documentation:
    v: Refine a search for MedicationAdministration resources for a given patient by specifying a date or a range of dates for the administration.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for MedicationAdministration resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: performer
  type:
    v: reference
  documentation:
    v: Refine a search for MedicationAdministration resources by one or more associated Practitioners.
search param:
  name:
    v: request
  type:
    v: reference
  documentation:
    v: Refine a search for MedicationAdministration resources by associated MedicationRequests.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for MedicationAdministration resources with one or more statuses.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for MedicationAdministration resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: MedicationDispense
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for MedicationDispense resources for a specified patient ID.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for MedicationDispense resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: MedicationRequest
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: authoredon
  type:
    v: date
  documentation:
    v: Further refine a search for MedicationRequest resources for a given patient by specifying a date or range of dates for when the medication was ordered. Note: all medications will be returned regardless of date range provided on the search.
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and discharge are supported.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for MedicationRequest resources for a given patient by specifying a date or a range of dates for when the medication was active.
search param:
  name:
    v: intent
  type:
    v: token
  documentation:
    v: Refine a search for MedicationRequest resources by one or more intents.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for MedicationRequest resources for a specified patient ID. You can use "patient" and "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for MedicationRequest resources by one or more statuses.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for MedicationRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: NutritionOrder
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for NutritionOrder resources for the specified patient ID.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Observation
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
interaction:
  code:
    v: update
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: based-on
  type:
    v: reference
  documentation:
    v: Refine a search for Observation resources by specifying a ServiceRequest associated with the Observation. (currently Genomics-only)
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Observation resources by category or SNOMED code. Epic categories are laboratory, vital-signs, social-history, core-characteristics, LDA, LDA-property, LDA-assessment, functional-mental-status, periodontal, labor-delivery, newborn-delivery, and obstetrics-gynecology. Supported SNOMED codes include 384821006, 118228005, 252275004, 275711006, 68793005, 395124008, 314076009, 19851009, and 405825005.
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Refine a search for Observation resources by code, including but not limited to LOINC code, SNOMED code, flowsheet row IDs, or SmartData Identifiers. Codes associated with the labor-delivery and newborn-delivery categories require that the category be specified.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for Observation resources by specifying a date or date range that a result- or vital sign-based Observation was resulted or recorded. This can also be used to refine the search results for labor-delivery, obstetrics-gynecology, and LDA based Observation searches. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
search param:
  name:
    v: focus
  type:
    v: reference
  documentation:
    v: Refine a search for Observation resources by specifying a Reference associated with the Observation. (currently only SmartData and obstetrics-gynecology)
search param:
  name:
    v: issued
  type:
    v: date
  documentation:
    v: Refine a search for Observation resources by specifying a date or date range that a social-history-based Observation was made available. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Observation resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Observation resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Organization
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Patient
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: address
  type:
    v: string
  documentation:
    v: Search for Patient resources using an address string.
search param:
  name:
    v: address-city
  type:
    v: string
  documentation:
    v: Search for Patient resources using the city for a patient's home address. You can use this parameter along with other address parameters.
search param:
  name:
    v: address-postalcode
  type:
    v: string
  documentation:
    v: Search for Patient resources using the postal code for a patient's home address. You can use this parameter along with other address parameters.
search param:
  name:
    v: address-state
  type:
    v: string
  documentation:
    v: Search for Patient resources using the state for a patient's home address. You can use this parameter along with other address parameters.
search param:
  name:
    v: birthdate
  type:
    v: date
  documentation:
    v: Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD).
search param:
  name:
    v: family
  type:
    v: string
  documentation:
    v: Search for Patient resources by family (last) name. You can use the family parameter along with other name parameters to search by a patient's name. Family name searching supports exact matching, "sounds like" matching, and patient aliases.
search param:
  name:
    v: gender
  type:
    v: token
  documentation:
    v: Search for Patient resources using the following gender codes: female, male, other, or unknown.
search param:
  name:
    v: given
  type:
    v: string
  documentation:
    v: Search for Patient resources by given (first) name. You can use the given parameter along with other name parameters to search by a patient's name. Given name searching supports both exact and "sounds like" matches. Patient aliases and dominant name aliases (ex. Bob for Robert) are also supported.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Search for Patient resources by a patient's identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. A patient's identifier must be in the format {|} or {<ID Type>|}<ID>.
search param:
  name:
    v: legal-sex
  type:
    v: token
  documentation:
    v: Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown.
search param:
  name:
    v: name
  type:
    v: string
  documentation:
    v: Search for Patient resources by a patient's name. To search on specific name parts use the name part parameters, such as family or given. This parameter is ignored if any name part parameters are used.
search param:
  name:
    v: own-name
  type:
    v: string
  documentation:
    v: Search for Patient resources by patient's own last name, usually used in non-US names. You can use the own-name parameter along with other name parameters to search by a patient's name.
search param:
  name:
    v: own-prefix
  type:
    v: string
  documentation:
    v: Search for Patient resources by patient's own last name prefix, usually used in non-US names. You can use the own-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included.
search param:
  name:
    v: partner-name
  type:
    v: string
  documentation:
    v: Search for Patient resources by patient's spouse's last name, usually used in non-US names. You can use the partner-name parameter along with other name parameters to search by a patient's name, but own-name must also be included.
search param:
  name:
    v: partner-prefix
  type:
    v: string
  documentation:
    v: Search for Patient resources by patient's spouse's last name prefix, usually used in non-US names. You can use the partner-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included.
search param:
  name:
    v: telecom
  type:
    v: token
  documentation:
    v: Search for Patient resources using a patient's home phone number, cell phone number, or email address.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Practitioner
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: address
  type:
    v: string
  documentation:
    v: Any part of an address (street, city, etc.) where a practitioner can be visited. When used, family is also required. Only respected if no other address parameters are populated. Only the first instance of this parameter is respected.
search param:
  name:
    v: address-city
  type:
    v: string
  documentation:
    v: The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected.
search param:
  name:
    v: address-postalcode
  type:
    v: string
  documentation:
    v: The zip code where a practitioner can be found. When used, family is also required.
search param:
  name:
    v: address-state
  type:
    v: string
  documentation:
    v: The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected.
search param:
  name:
    v: family
  type:
    v: string
  documentation:
    v: A practitioner's family (last) name. Only the first instance of this parameter is respected.
search param:
  name:
    v: given
  type:
    v: string
  documentation:
    v: A practitioner's given (first) name. When used, family is also required. Only the first instance of this parameter is respected.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: A practitioner's identifier in the format |. When this parameter is provided, all others (except _id) are ignored.
search param:
  name:
    v: name
  type:
    v: string
  documentation:
    v: Any part of a practitioner's name. For full names, format should be first last. When specified, family and given are ignored. Only the first instance of this parameter is respected.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: PractitionerRole
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: email
  type:
    v: token
  documentation:
    v: Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Search for PractitionerRoles using identifiers. A code system is required. The code must be prepended with URN:OID. Some codes may need to be URL encoded prior to query.
search param:
  name:
    v: location
  type:
    v: reference
  documentation:
    v: Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected.
search param:
  name:
    v: organization
  type:
    v: reference
  documentation:
    v: Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected.
search param:
  name:
    v: phone
  type:
    v: token
  documentation:
    v: Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored.
search param:
  name:
    v: practitioner
  type:
    v: reference
  documentation:
    v: Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected.
search param:
  name:
    v: role
  type:
    v: token
  documentation:
    v: Refine a search for a PractitionerRole by entering a valid role. System must be included.
search param:
  name:
    v: specialty
  type:
    v: token
  documentation:
    v: Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported.
search param:
  name:
    v: telecom
  type:
    v: token
  documentation:
    v: Refine a search for a PractitionerRole for a specific telecom. System must be specified as either 'phone' or 'email'
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Procedure
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Procedure resources by category. Only the following values are supported: 103693007 (diagnostic procedures), 387713003 (surgical procedures), 9632001 (nursing procedures, Netherlands only), and 225317005 or freedom-restricting-intervention (restricting intervention, Netherlands only) are supported.
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Refine a search for Procedure resources by specifying a date or date range that a Procedure was resulted. Enter dates in ISO format (YYYY[-MM[-DD]]). Not supported by nursing procedures or restricting interventions.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Procedure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Procedure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Provenance
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: Questionnaire
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: QuestionnaireResponse
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for QuestionnaireResponses by encounter
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for QuestionnaireResponses for a specified patient. You can also use "subject" equivalently
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for QuestionnaireResponses for a specified patient. You can also use "patient" equivalently
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: RelatedPerson
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: RequestGroup
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ResearchStudy
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: Search for the ResearchStudy resource for a specified study code.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Search for the ResearchStudy resource for a specified status
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ResearchSubject
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for the ResearchSubject resources related to a specified patient
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Search for the ResearchSubject resources for a specified status.
search param:
  name:
    v: study
  type:
    v: reference
  documentation:
    v: Search for the ResearchSubject resources related to a specified study
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ServiceRequest
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for ServiceRequests of a particular category. By default, all ServiceRequests are returned.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for ServiceRequest resources for specific encounters. If not provided, all ServiceRequest results are returned.
search param:
  name:
    v: onlyscannable
  type:
    v: token
  documentation:
    v: Refine a search for ServiceRequest resources to scannable only. By default, all ServiceRequests are returned. Use a value of "true" to only return scannable ServiceRequests. Can only be used when the application is launched from Hyperspace.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search ServiceRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: requester
  type:
    v: reference
  documentation:
    v: Refine a search for ServiceRequest resources by individual making the request. By default, all ServiceRequests are returned.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for ServiceRequest resources by status. By default, all ServiceRequests are returned. Statuses of draft, active, completed, revoked, and unknown are supported.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search ServiceRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Specimen
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Substance
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: Task
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
interaction:
  code:
    v: update
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: Provenance:target
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Specify community-resource for CRRN tasks, episode-checklist for Episode Checklist tasks. When nothing is specified, all valid tasks are returned.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Further refine the search for a task by specifying the encounter associated with the task. For Episode Checklist tasks, only tasks created in this encounter will be returned.
search param:
  name:
    v: focus
  type:
    v: reference
  documentation:
    v: Specify the EpisodeOfCare FHIR ID to search for Episode Checklist tasks.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Task resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Restrict the search for tasks based on task status. Only respected by Episode Checklist tasks.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for Task resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
search param:
  name:
    v: _id
  type:
    v: token
  documentation:
    v: FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
search param:
  name:
    v: _count
  type:
    v: number
  documentation:
    v: Number of results per page.

type:
  v: ValueSet
interaction:
  code:
    v: read
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported