Finnish Implementation Guide for SMART App Launch
1.0.1-cibuild - ci-build
Finnish Implementation Guide for SMART App Launch
1.0.1-cibuild - ci-build
Finnish Implementation Guide for SMART App Launch, published by HL7 Finland ry. This guide is not an authorized publication; it is the continuous build for version 1.0.1-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fhir-fi/finnish-smart/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apotti-eko01 | Version: 1.0.1-cibuild | |||
| Active as of 2023-07-04 | Computable Name: CapabilityStatementExampleApotti | |||
Copyright/Legal: Copyright Epic 1979-2022 |
||||
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement apotti-eko01
xml, jsonNote 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
serverOAuth, SMART-on-FHIR, BasicThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| 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 | ||||
| Communication | y | y | y | based-on, category, encounter, part-of, patient, subject, _id, _count | * | Provenance:target | |||
| ConceptMap | y | y | |||||||
| Condition | y | y | y | abatement-date, category, clinical-status, code, encounter, onset-date, patient, recorded-date, subject, _id, _count | * | Provenance:target | |||
| Consent | y | y | category, patient, status, subject, _id, _count | * | Provenance:target | ||||
| Coverage | y | y | beneficiary, patient, _id, _count | * | Provenance:target | ||||
| Device | y | y | device-name, manufacturer, model, patient, udi-carrier, udi-di, _id, _count | * | Provenance:target | ||||
| DeviceRequest | y | y | patient, status, _id, _count | * | Provenance:target | ||||
| DeviceUseStatement | y | y | patient, subject, _id, _count | * | Provenance:target | ||||
| DiagnosticReport | y | y | y | category, code, date, identifier, patient, subject, _id, _count | * | Provenance:target | |||
| DocumentReference | y | y | y | y | author, category, date, docstatus, encounter, patient, period, status, subject, type, _id, _count | * | Provenance:target | ||
| Encounter | y | y | class, date, identifier, onlyscannable, patient, subject, _id, _count | * | Provenance:target | ||||
| Endpoint | y | ||||||||
| EpisodeOfCare | y | y | patient, status, type, _id, _count | * | Provenance:target | ||||
| ExplanationOfBenefit | y | y | created, patient, _id, _count | * | Provenance:target | ||||
| FamilyMemberHistory | y | y | patient, _id, _count | * | Provenance:target | ||||
| Flag | y | y | category, encounter, patient, status, subject, _id, _count | * | Provenance:target | ||||
| Goal | y | y | category, lifecycle-status, patient, subject, _id, _count | * | Provenance:target | ||||
| Group | y | y | _id, _count | * | Provenance:target | ||||
| ImagingStudy | y | y | identifier, patient, subject, _id, _count | * | Provenance:target | ||||
| Immunization | y | y | date, patient, status, _id, _count | * | Provenance:target | ||||
| ImmunizationRecommendation | y | y | patient, _id, _count | * | Provenance:target | ||||
| List | y | y | code, encounter, patient, subject, _id, _count | * | Provenance:target | ||||
| Location | y | y | _id, _count | * | Provenance:target | ||||
| Measure | y | y | _id, _count | * | Provenance:target | ||||
| MeasureReport | y | y | _id, _count | * | Provenance:target | ||||
| Medication | y | y | _id, _count | * | Provenance:target | ||||
| MedicationAdministration | y | y | context, effective-time, patient, performer, request, status, subject, _id, _count | * | Provenance:target | ||||
| MedicationDispense | y | y | patient, subject, _id, _count | * | Provenance:target | ||||
| MedicationRequest | y | y | authoredon, category, date, intent, patient, status, subject, _id, _count | * | Provenance:target | ||||
| NutritionOrder | y | y | patient, _id, _count | * | Provenance:target | ||||
| Observation | y | y | y | y | based-on, category, code, date, focus, issued, patient, subject, _id, _count | * | Provenance:target | ||
| Organization | y | y | _id, _count | * | Provenance:target | ||||
| Patient | y | y | y | address, address-city, address-postalcode, address-state, birthdate, family, gender, given, identifier, legal-sex, name, own-name, own-prefix, partner-name, partner-prefix, telecom, _id, _count | * | Provenance:target | |||
| Practitioner | y | y | address, address-city, address-postalcode, address-state, family, given, identifier, name, _id, _count | * | Provenance:target | ||||
| PractitionerRole | y | y | email, identifier, location, organization, phone, practitioner, role, specialty, telecom, _id, _count | * | Provenance:target | ||||
| Procedure | y | y | category, date, patient, subject, _id, _count | * | Provenance:target | ||||
| Provenance | y | ||||||||
| Questionnaire | y | y | _id, _count | * | Provenance:target | ||||
| QuestionnaireResponse | y | y | y | encounter, patient, subject, _id, _count | * | Provenance:target | |||
| RelatedPerson | y | ||||||||
| RequestGroup | y | y | _id, _count | * | Provenance:target | ||||
| ResearchStudy | y | y | identifier, status, _id, _count | * | Provenance:target | ||||
| ResearchSubject | y | y | patient, status, study, _id, _count | * | Provenance:target | ||||
| ServiceRequest | y | y | category, encounter, onlyscannable, patient, requester, status, subject, _id, _count | * | Provenance:target | ||||
| Specimen | y | y | _id, _count | * | Provenance:target | ||||
| Substance | y | y | _id, _count | * | Provenance:target | ||||
| Task | y | y | y | code, encounter, focus, patient, status, subject, _id, _count | * | Provenance:target | |||
| ValueSet | y |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | seriousness | token | Refine a search for AdverseEvent resources by seriousness of the event. Serious and Non-serious are the only supported values. |
| SHALL | study | reference | Search for AdverseEvent resources for a specified study ID. |
| SHALL | subject | reference | Search for AdverseEvent resources for a specified patient ID. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
create, read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | clinical-status | token | Refine a search for AllergyIntolerance resources by clinicalStatus. Active is the only supported clinical status to search by. |
| SHALL | patient | reference | Search for AllergyIntolerance resources for a specified patient ID. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | date | date | Refine a search for Appointment resources by date. By default, all Appointments are returned. Not supported for scheduled surgeries. |
| SHALL | identifier | token | Refine a search for Appointment resources by identifier. Not supported for scheduled surgeries. |
| SHALL | patient | reference | Search for Appointment resources for a specified patient ID. |
| SHALL | service-category | token | Search on the type of appointment. Enter 'surgery' for scheduled surgery appointments, and 'appointment' for all other types of appointments. |
| SHALL | status | token | Refine a search for Appointment resources by status. By default, all Appointments are returned. Not supported for scheduled surgeries. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | location | token | Refine a search for BodyStructure resources by identifier. Enter using the structure "[system]|[search string]". |
| SHALL | morphology | token | Refine a search for BodyStructure resources by morphology. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | activity-date | date | Search for CarePlan resources with questionaires due before the provided date. |
| SHALL | category | token | Search for CarePlans of the given type. This is a required search parameter. |
| SHALL | encounter | reference | Refine a search for Encounter CarePlans to search only the encounters provided. Ignored if not searching for Encounter CarePlans. |
| SHALL | patient | reference | 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. |
| SHALL | part-of | reference | 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. |
| SHALL | status | token | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 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. |
| SHALL | status | token | Refine a search based on the CareTeam's status. Currently only active is supported. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
create, read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | based-on | reference | 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. |
| SHALL | category | token | Refine a search to include only Communication resources with the given categories. |
| SHALL | encounter | reference | Refine a search to include Communication resources from only the encounters provided. |
| SHALL | part-of | reference | Refine a search for Communication resources "part of" a specified Task ID. If not provided, all Communications are returned. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | abatement-date | date | Search for Conditions with a specified abatement date. This is only used when searching for infections. |
| SHALL | category | token | Search for Condition resources by category. |
| SHALL | clinical-status | token | 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. |
| SHALL | code | token | Search for Conditions with a specified code. This is only used when searching for infections. |
| SHALL | encounter | reference | Search for Condition resources for specific encounters. |
| SHALL | onset-date | date | Search for Conditions with a specified onset date. This is only used when searching for infections. |
| SHALL | patient | reference | 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. |
| SHALL | recorded-date | date | Search for Conditions with a specified recorded date. This is only used when searching for infections. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | Search for Consent resources by category. |
| SHALL | patient | reference | 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. |
| SHALL | status | token | Search for Consent resources by status. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | beneficiary | reference | 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. |
| SHALL | patient | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | device-name | string | A string that will match the Device.deviceName.name field. Not case sensitive. |
| SHALL | manufacturer | string | Manufacturer of the device. |
| SHALL | model | string | Model number of the device. |
| SHALL | patient | reference | The patient in whom this device is implanted. This is a required parameter. |
| SHALL | udi-carrier | string | The UDI barcode string - matches static UDI. |
| SHALL | udi-di | string | The UDI device identifier (DI). |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search for DeviceRequest resource for a specified patient ID. |
| SHALL | status | token | Search for a DeviceRequest based on a device request status |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
read, search-type, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | Refine a search for DiagnosticReport resources by category. |
| SHALL | code | token | Refine a search for DiagnosticReport resources by code. |
| SHALL | date | date | 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. |
| SHALL | identifier | token | Refine search by specifying an identifier, such as the internal order ID or the accession number. Not supported by Care Plan Goal. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
create, read, search-type, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | author | reference | 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. |
| SHALL | category | token | Refine a search for DocumentReference resources by category. |
| SHALL | date | date | 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. |
| SHALL | docstatus | token | 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. |
| SHALL | encounter | reference | Search for DocumentReference resources for a specified encounter ID. Not supported for correspondence, imaging-result, or questionnaire-response search. |
| SHALL | patient | reference | 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. |
| SHALL | period | date | 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. |
| SHALL | status | token | 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. |
| SHALL | subject | reference | 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. |
| SHALL | type | token | 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=<code> to search all supported systems with that code or type=<system>|<code> to further refine the search to one code system. Not supported for questionnaire-response search. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | class | token | Refine a search for Encounter resources by class. By default, all classes are returned. |
| SHALL | date | date | 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. |
| SHALL | identifier | token | Search for Encounter resources by encounter identifier in the format <code system>|<code> |
| SHALL | onlyscannable | token | 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. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search for EpisodeOfCare resources for a specified patient ID. |
| SHALL | status | token | Refine a search for EpisodeOfCare resources by status. Active, finished, and cancelled are the only supported statuses. |
| SHALL | type | token | Refine a search for EpisodeOfCare resources by type. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | created | date | 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. |
| SHALL | patient | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Required: the patient whose family history you'd like to search. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | Refine a search for Flag resources by category. |
| SHALL | encounter | reference | Refine a search for Flag resources by encounter. This is currently only supported for the isolation category. |
| SHALL | patient | reference | 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. |
| SHALL | status | token | Refine a search for Flag resources by status. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | Refines a search by Goal category. |
| SHALL | lifecycle-status | token | Refines a search based on Goal lifecycle status. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $group-export |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | 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 <code system>|<code> or <ID Type>|<ID>. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | date | date | 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. |
| SHALL | patient | reference | Search for Immunization resources for a specified patient ID. |
| SHALL | status | token | Refine a search for Immunization resources by status. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Refine a search for List resources by list type. Accepted values include "medications," "allergies," "immunizations," "problems," "pedigree-list," and "hospital-problems." |
| SHALL | encounter | reference | Refine a search for List resources by encounter. |
| SHALL | patient | reference | Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references. |
| SHALL | subject | reference | Refine a search for List resources by patient. You can use "patient" or "subject" equivalently, but not at the same time with different references. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | context | reference | Refine a search for MedicationAdministration resources with one or more linked encounters. |
| SHALL | effective-time | date | Refine a search for MedicationAdministration resources for a given patient by specifying a date or a range of dates for the administration. |
| SHALL | patient | reference | 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. |
| SHALL | performer | reference | Refine a search for MedicationAdministration resources by one or more associated Practitioners. |
| SHALL | request | reference | Refine a search for MedicationAdministration resources by associated MedicationRequests. |
| SHALL | status | token | Refine a search for MedicationAdministration resources with one or more statuses. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search for MedicationDispense resources for a specified patient ID. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | authoredon | date | 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. |
| SHALL | category | token | Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and discharge are supported. |
| SHALL | date | date | 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. |
| SHALL | intent | token | Refine a search for MedicationRequest resources by one or more intents. |
| SHALL | patient | reference | 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. |
| SHALL | status | token | Refine a search for MedicationRequest resources by one or more statuses. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search for NutritionOrder resources for the specified patient ID. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
create, read, search-type, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | based-on | reference | Refine a search for Observation resources by specifying a ServiceRequest associated with the Observation. (currently Genomics-only) |
| SHALL | category | token | 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. |
| SHALL | code | token | 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. |
| SHALL | date | date | 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. |
| SHALL | focus | reference | Refine a search for Observation resources by specifying a Reference associated with the Observation. (currently only SmartData and obstetrics-gynecology) |
| SHALL | issued | date | 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. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | address | string | Search for Patient resources using an address string. |
| SHALL | address-city | string | Search for Patient resources using the city for a patient's home address. You can use this parameter along with other address parameters. |
| SHALL | address-postalcode | string | Search for Patient resources using the postal code for a patient's home address. You can use this parameter along with other address parameters. |
| SHALL | address-state | string | Search for Patient resources using the state for a patient's home address. You can use this parameter along with other address parameters. |
| SHALL | birthdate | date | Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD). |
| SHALL | family | string | 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. |
| SHALL | gender | token | Search for Patient resources using the following gender codes: female, male, other, or unknown. |
| SHALL | given | string | 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. |
| SHALL | identifier | token | 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 {<code system>|}<code> or {<ID Type>|}<ID>. |
| SHALL | legal-sex | token | Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown. |
| SHALL | name | string | 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. |
| SHALL | own-name | string | 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. |
| SHALL | own-prefix | string | 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. |
| SHALL | partner-name | string | 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. |
| SHALL | partner-prefix | string | 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. |
| SHALL | telecom | token | Search for Patient resources using a patient's home phone number, cell phone number, or email address. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | address | string | 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. |
| SHALL | address-city | string | The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected. |
| SHALL | address-postalcode | string | The zip code where a practitioner can be found. When used, family is also required. |
| SHALL | address-state | string | The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected. |
| SHALL | family | string | A practitioner's family (last) name. Only the first instance of this parameter is respected. |
| SHALL | given | string | A practitioner's given (first) name. When used, family is also required. Only the first instance of this parameter is respected. |
| SHALL | identifier | token | A practitioner's identifier in the format <code system>|<code>. When this parameter is provided, all others (except _id) are ignored. |
| SHALL | name | string | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | token | Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored. | |
| SHALL | identifier | token | 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. |
| SHALL | location | reference | Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected. |
| SHALL | organization | reference | Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected. |
| SHALL | phone | token | Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored. |
| SHALL | practitioner | reference | Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected. |
| SHALL | role | token | Refine a search for a PractitionerRole by entering a valid role. System must be included. |
| SHALL | specialty | token | Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported. |
| SHALL | telecom | token | Refine a search for a PractitionerRole for a specific telecom. System must be specified as either 'phone' or 'email' |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | 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. |
| SHALL | date | date | 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. |
| SHALL | patient | reference | 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. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
create, read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | encounter | reference | Search for QuestionnaireResponses by encounter |
| SHALL | patient | reference | Search for QuestionnaireResponses for a specified patient. You can also use "subject" equivalently |
| SHALL | subject | reference | Search for QuestionnaireResponses for a specified patient. You can also use "patient" equivalently |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Search for the ResearchStudy resource for a specified study code. |
| SHALL | status | token | Search for the ResearchStudy resource for a specified status |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Search for the ResearchSubject resources related to a specified patient |
| SHALL | status | token | Search for the ResearchSubject resources for a specified status. |
| SHALL | study | reference | Search for the ResearchSubject resources related to a specified study |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | category | token | Refine a search for ServiceRequests of a particular category. By default, all ServiceRequests are returned. |
| SHALL | encounter | reference | Search for ServiceRequest resources for specific encounters. If not provided, all ServiceRequest results are returned. |
| SHALL | onlyscannable | token | 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. |
| SHALL | patient | reference | 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. |
| SHALL | requester | reference | Refine a search for ServiceRequest resources by individual making the request. By default, all ServiceRequests are returned. |
| SHALL | status | token | Refine a search for ServiceRequest resources by status. By default, all ServiceRequests are returned. Statuses of draft, active, completed, revoked, and unknown are supported. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Specify community-resource for CRRN tasks, episode-checklist for Episode Checklist tasks. When nothing is specified, all valid tasks are returned. |
| SHALL | encounter | reference | 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. |
| SHALL | focus | reference | Specify the EpisodeOfCare FHIR ID to search for Episode Checklist tasks. |
| SHALL | patient | reference | 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. |
| SHALL | status | token | Restrict the search for tasks based on task status. Only respected by Episode Checklist tasks. |
| SHALL | subject | reference | 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. |
| SHALL | _id | token | FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored. |
| SHALL | _count | number | Number of results per page. |
IG © 2022+ HL7 Finland ry. Package hl7.fhir.fi.smart#1.0.1-cibuild based on FHIR 4.0.1. Generated 2024-08-16
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change