apottiekosysteemi-capabilitystatement
type: CapabilityStatement
node role: treeRoot
id:
  v: apottiekosysteemi-capabilitystatement
meta:
  profile:
    v: https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-server-profile
    link: https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-server-profile
text:
  status:
    v: extensions
  div: Mode SERVER Description Transaction System History System Search Resource Type Profile Read Search Update Create AllergyIntolerance y y y Appointment y y Binary y Condition y y y Consent y y Coverage y y Device y y DeviceRequest y y DeviceUseStatement y y DiagnosticReport y y DocumentReference y y y Encounter y y Endpoint y Flag y y Goal y y y Immunization y y ImmunizationRecommendation y y List y y Location y Medication y MedicationDispense y y MedicationRequest y y MedicationStatement y y NutritionOrder y y Observation y y y y Organization y Patient y y y Practitioner y y PractitionerRole y y Procedure y y ProcedureRequest y y Schedule y Slot y Specimen y y
url:
  v: https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apottiekosysteemi-capabilitystatement
version:
  v: 1.0.0-rc5
status:
  v: active
experimental:
  v: true
date:
  v: 2023-01-17T10:35:03Z
publisher:
  v: HL7 Finland
contact:
  name:
    v: HL7 Finland
  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
software:
  name:
    v: Epic
  version:
    v: toukokuu 2022
  release date:
    v: 2022-09-12
fhir version:
  v: 3.0.1
format:
  v: xml
format:
  v: json
rest:
  mode:
    v: server
  security:
    extension:
      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: 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 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.
  resource:
    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 param:
      name:
        v: date
      type:
        v: date
      documentation:
        v: Refine a search for Appointment resources by date. By default, all Appointments are returned.
    search param:
      name:
        v: identifier
      type:
        v: token
      documentation:
        v: Refine a search for Appointment resources by identifier.
    search param:
      name:
        v: patient
      type:
        v: reference
      documentation:
        v: Search for Appointment resources for a specified patient ID.
    search param:
      name:
        v: status
      type:
        v: token
      documentation:
        v: Refine a search for Appointment resources by status. By default, all Appointments are returned.
    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: Binary
    interaction:
      code:
        v: read
    read history:
      v: false
    update create:
      v: false
    conditional create:
      v: false

v: authorize

v: token

v: OAuth

v: OAuth

v: SMART-on-FHIR

v: SMART-on-FHIR

v: Basic

v: Basic

v: not-supported

v: false

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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Condition resources by category. By default, the search returns problem list Condition resources.
search param:
  name:
    v: clinical-status
  type:
    v: token
  documentation:
    v: Refine a search for Condition resources by clinicalStatus. By default, the search returns active Condition resources. Only clinical statuses of resolved and active are supported.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for Condition resources for specific encounters. If not provided, only problem list Condition results are returned.
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: 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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a 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: Refine a 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 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 param:
  name:
    v: device-name
  type:
    v: string
  documentation:
    v: A string that will match the Device.udi.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 param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for a 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 param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for DeviceUseStatement 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.

type:
  v: DiagnosticReport
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 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: 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
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 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. Not supported for ccda-document or clinical-note search.
search param:
  name:
    v: class
  type:
    v: token
  documentation:
    v: Refine a search for DocumentReference resources by category. Only "clinical-note", "ccda-document", "correspondence", and "imaging-result" are supported.
search param:
  name:
    v: created
  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 document creation time. Not supported for correspondence or imaging-result search.
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 ccda-document, correspondence, or imaging-result search.
search param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for DocumentReference resources for a specified encounter ID. Not supported for ccda-document, correspondence, or imaging-result search.
search param:
  name:
    v: indexed
  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 document indexed time. Not supported for ccda-document or clinical-note 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.
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 LOINC code or internal category ID to return only documents of that type. Not supported for ccda-document 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 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: 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: 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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Flag resources by 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: 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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refines a search by Goal Category. This parameter is ignored if searching via _ID.
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. This parameter is ignored if searching via _ID.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refines a search based on Goal Status. This parameter is ignored if searching via _ID. This parameter is only supported by patient goals.
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. This parameter is ignored if searching via _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: 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 param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: 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. This parameter is ignored if searching via ids.
search param:
  name:
    v: notgiven
  type:
    v: token
  documentation:
    v: A boolean that indicates whether or not an immunization has been administered. This parameter is ignored if searching via ids.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for Immunization resources for a specified patient ID. This parameter is ignored if searching via ids.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for Immunization by status. Completed is the only supported 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 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 param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: The kind of list to search for (e.g. PatientList)
search param:
  name:
    v: date
  type:
    v: date
  documentation:
    v: Used to return patients that have questionnaires due by a certain date.
search param:
  name:
    v: identifier
  type:
    v: token
  documentation:
    v: An internal id and system allowing access to a list without knowing its FHIR ID (currently supports Patient Lists).
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
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: Medication
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: 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 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 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 a 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, and community are supported.
search param:
  name:
    v: patient
  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 difference references.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for MedicationRequest resources by one or more statuses. By default, only medications with active statuses are returned. MedicationRequest searches support active, on-hold, completed and stopped. If searching by status, active must be included.
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: MedicationStatement
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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for MedicationStatement resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and patientspecified are supported.
search param:
  name:
    v: effective
  type:
    v: date
  documentation:
    v: Further refine a search for MedicationStatement resources for a given patient by specifying a date or a 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: patient
  type:
    v: reference
  documentation:
    v: Search for MedicationStatement 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: status
  type:
    v: token
  documentation:
    v: Refine a search for MedicationStatement resources by one or more statuses. By default, only medications with active statuses are returned. MedicationStatement searches support active, on-hold, completed, and stopped. If searching by status, active must be included.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for MedicationStatement 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 param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for NutritionOrder 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.

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 param:
  name:
    v: category
  type:
    v: token
  documentation:
    v: Refine a search for Observation resources by category. Only laboratory, vital-signs, social-history, core-characteristics, functional-mental-status, LDA, and SNOMED codes 384821006 and 118228005 are supported.
search param:
  name:
    v: code
  type:
    v: token
  documentation:
    v: Refine a search for Observation resources by LOINC code, SNOMED code, or flowsheet row IDs.
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. 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: 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
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: 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 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 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 |. Code system must be a URN. 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 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 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: ProcedureRequest
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 param:
  name:
    v: encounter
  type:
    v: reference
  documentation:
    v: Search for ProcedureRequest resources for specific encounters. If not provided, all ProcedureRequest results are returned.
search param:
  name:
    v: patient
  type:
    v: reference
  documentation:
    v: Search for ProcedureRequest 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 ProcedureRequest resources by individual making the request. By defualt, all ProcedureRequests are returned.
search param:
  name:
    v: status
  type:
    v: token
  documentation:
    v: Refine a search for ProcedureRequest resources by status. By default, only active ProcedureRequests are returned. Statuses of draft, active, completed, cancelled, and unknown are supported.
search param:
  name:
    v: subject
  type:
    v: reference
  documentation:
    v: Search for ProcedureRequest 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: Schedule
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: Slot
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: 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 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.