Finnish Implementation Guide for SMART App Launch
1.0.0-rc7 - ci-build
Finnish Implementation Guide for SMART App Launch
1.0.0-rc7 - ci-build
This page is part of the Finnish Implementation Guide for SMART App Launch (v0.3.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0-rc3. For a full list of available versions, see the Directory of published versions
| Active as of 2023-01-17 |
{
"resourceType" : "CapabilityStatement",
"id" : "apottiekosysteemi-capabilitystatement",
"meta" : {
"profile" : [
"https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-server-profile"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2/><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title=\"GET a resource (read interaction)\">Read</b></th><th><b title=\"GET all set of resources of the type (search interaction)\">Search</b></th><th><b title=\"PUT a new resource version (update interaction)\">Update</b></th><th><b title=\"POST a new resource (create interaction)\">Create</b></th></tr><tr><td>AllergyIntolerance</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td>y</td></tr><tr><td>Appointment</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Binary</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Condition</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td>y</td></tr><tr><td>Consent</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Coverage</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Device</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>DeviceRequest</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>DeviceUseStatement</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>DiagnosticReport</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>DocumentReference</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td>y</td></tr><tr><td>Encounter</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Endpoint</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Flag</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Goal</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td>y</td></tr><tr><td>Immunization</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>ImmunizationRecommendation</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>List</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Location</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Medication</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>MedicationDispense</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>MedicationRequest</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>MedicationStatement</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>NutritionOrder</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Observation</td><td>\u00a0</td><td>y</td><td>y</td><td>y</td><td>y</td></tr><tr><td>Organization</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Patient</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td>y</td></tr><tr><td>Practitioner</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>PractitionerRole</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Procedure</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>ProcedureRequest</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr><tr><td>Schedule</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Slot</td><td>\u00a0</td><td>y</td><td></td><td></td><td></td></tr><tr><td>Specimen</td><td>\u00a0</td><td>y</td><td>y</td><td></td><td></td></tr></table></div>"
},
"url" : "https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apottiekosysteemi-capabilitystatement",
"version" : "1.0.0-rc7",
"status" : "active",
"experimental" : true,
"date" : "2023-01-17T10:35:03Z",
"publisher" : "HL7 Finland",
"contact" : [
{
"name" : "HL7 Finland",
"telecom" : [
{
"system" : "url",
"value" : "https://www.hl7.fi/"
},
{
"system" : "email",
"value" : "mikael@sensotrend.com"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "FI",
"display" : "Finland"
}
]
}
],
"copyright" : "Copyright Epic 1979-2022",
"kind" : "instance",
"software" : {
"name" : "Epic",
"version" : "toukokuu 2022",
"releaseDate" : "2022-09-12"
},
"fhirVersion" : "3.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"extension" : [
{
"extension" : [
{
"url" : "authorize",
"valueUri" : "https://gw.apottiekosysteemi.fi/Interconnect-FHIR-EKO01/oauth2/authorize"
},
{
"url" : "token",
"valueUri" : "https://gw.apottiekosysteemi.fi/Interconnect-FHIR-EKO01/oauth2/token"
}
],
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
],
"cors" : true,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "OAuth",
"display" : "OAuth"
}
],
"text" : "OAuth"
},
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR",
"display" : "SMART-on-FHIR"
}
],
"text" : "SMART-on-FHIR"
},
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "Basic",
"display" : "Basic"
}
],
"text" : "Basic"
}
]
},
"resource" : [
{
"type" : "AllergyIntolerance",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for AllergyIntolerance resources for a specified patient ID."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Appointment",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "date",
"type" : "date",
"documentation" : "Refine a search for Appointment resources by date. By default, all Appointments are returned."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Refine a search for Appointment resources by identifier."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for Appointment resources for a specified patient ID."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Refine a search for Appointment resources by status. By default, all Appointments are returned."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Binary",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Condition",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for Condition resources by category. By default, the search returns problem list Condition resources."
},
{
"name" : "clinical-status",
"type" : "token",
"documentation" : "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."
},
{
"name" : "encounter",
"type" : "reference",
"documentation" : "Search for Condition resources for specific encounters. If not provided, only problem list Condition results are returned."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Consent",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for Consent resources by category."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Refine a search for Consent resources by status."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Coverage",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "beneficiary",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Device",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "device-name",
"type" : "string",
"documentation" : "A string that will match the Device.udi.name field. Not case sensitive."
},
{
"name" : "manufacturer",
"type" : "string",
"documentation" : "Manufacturer of the device."
},
{
"name" : "model",
"type" : "string",
"documentation" : "Model number of the device."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "The patient in whom this device is implanted. This is a required parameter."
},
{
"name" : "udi-carrier",
"type" : "string",
"documentation" : "The UDI barcode string - matches static UDI."
},
{
"name" : "udi-di",
"type" : "string",
"documentation" : "The UDI device identifier (DI)."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "DeviceRequest",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for a DeviceRequest resource for a specified patient ID."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Search for a DeviceRequest based on a device request status"
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "DeviceUseStatement",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for DeviceUseStatement resources for a specified patient ID."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "DiagnosticReport",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for DiagnosticReport resources by category."
},
{
"name" : "code",
"type" : "token",
"documentation" : "Refine a search for DiagnosticReport resources by code."
},
{
"name" : "date",
"type" : "date",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "DocumentReference",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "author",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "class",
"type" : "token",
"documentation" : "Refine a search for DocumentReference resources by category. Only \"clinical-note\", \"ccda-document\", \"correspondence\", and \"imaging-result\" are supported."
},
{
"name" : "created",
"type" : "date",
"documentation" : "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."
},
{
"name" : "docstatus",
"type" : "token",
"documentation" : "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."
},
{
"name" : "encounter",
"type" : "reference",
"documentation" : "Search for DocumentReference resources for a specified encounter ID. Not supported for ccda-document, correspondence, or imaging-result search."
},
{
"name" : "indexed",
"type" : "date",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "period",
"type" : "date",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "type",
"type" : "token",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Encounter",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "class",
"type" : "token",
"documentation" : "Refine a search for Encounter resources by class. By default, all classes are returned."
},
{
"name" : "date",
"type" : "date",
"documentation" : "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."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Search for Encounter resources by encounter identifier in the format <code system>|<code>"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Endpoint",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Flag",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for Flag resources by category."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Refine a search for Flag resources by status."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Goal",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refines a search by Goal Category. This parameter is ignored if searching via _ID."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Refines a search based on Goal Status. This parameter is ignored if searching via _ID. This parameter is only supported by patient goals."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Immunization",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "date",
"type" : "date",
"documentation" : "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."
},
{
"name" : "notgiven",
"type" : "token",
"documentation" : "A boolean that indicates whether or not an immunization has been administered. This parameter is ignored if searching via ids."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for Immunization resources for a specified patient ID. This parameter is ignored if searching via ids."
},
{
"name" : "status",
"type" : "token",
"documentation" : "Refine a search for Immunization by status. Completed is the only supported status."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "ImmunizationRecommendation",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "List",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "code",
"type" : "token",
"documentation" : "The kind of list to search for (e.g. PatientList)"
},
{
"name" : "date",
"type" : "date",
"documentation" : "Used to return patients that have questionnaires due by a certain date."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "An internal id and system allowing access to a list without knowing its FHIR ID (currently supports Patient Lists)."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Location",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Medication",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "MedicationDispense",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for MedicationDispense resources for a specified patient ID."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "MedicationRequest",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "authoredon",
"type" : "date",
"documentation" : "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."
},
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, and community are supported."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "status",
"type" : "token",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "MedicationStatement",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "Refine a search for MedicationStatement resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and patientspecified are supported."
},
{
"name" : "effective",
"type" : "date",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "status",
"type" : "token",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "NutritionOrder",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference",
"documentation" : "Search for NutritionOrder resources for a specified patient ID."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Observation",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
},
{
"code" : "update"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "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."
},
{
"name" : "code",
"type" : "token",
"documentation" : "Refine a search for Observation resources by LOINC code, SNOMED code, or flowsheet row IDs."
},
{
"name" : "date",
"type" : "date",
"documentation" : "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."
},
{
"name" : "issued",
"type" : "date",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Organization",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Patient",
"interaction" : [
{
"code" : "create"
},
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "address",
"type" : "string",
"documentation" : "Search for Patient resources using an address string."
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "Search for Patient resources using the city for a patient's home address. You can use this parameter along with other address parameters."
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "Search for Patient resources using the postal code for a patient's home address. You can use this parameter along with other address parameters."
},
{
"name" : "address-state",
"type" : "string",
"documentation" : "Search for Patient resources using the state for a patient's home address. You can use this parameter along with other address parameters."
},
{
"name" : "birthdate",
"type" : "date",
"documentation" : "Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD)."
},
{
"name" : "family",
"type" : "string",
"documentation" : "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."
},
{
"name" : "gender",
"type" : "token",
"documentation" : "Search for Patient resources using the following gender codes: female, male, other, or unknown."
},
{
"name" : "given",
"type" : "string",
"documentation" : "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."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "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>."
},
{
"name" : "legal-sex",
"type" : "token",
"documentation" : "Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown."
},
{
"name" : "name",
"type" : "string",
"documentation" : "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."
},
{
"name" : "own-name",
"type" : "string",
"documentation" : "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."
},
{
"name" : "own-prefix",
"type" : "string",
"documentation" : "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."
},
{
"name" : "partner-name",
"type" : "string",
"documentation" : "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."
},
{
"name" : "partner-prefix",
"type" : "string",
"documentation" : "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."
},
{
"name" : "telecom",
"type" : "token",
"documentation" : "Search for Patient resources using a patient's home phone number, cell phone number, or email address."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Practitioner",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "address",
"type" : "string",
"documentation" : "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."
},
{
"name" : "address-city",
"type" : "string",
"documentation" : "The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected."
},
{
"name" : "address-postalcode",
"type" : "string",
"documentation" : "The zip code where a practitioner can be found. When used, family is also required."
},
{
"name" : "address-state",
"type" : "string",
"documentation" : "The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected."
},
{
"name" : "family",
"type" : "string",
"documentation" : "A practitioner's family (last) name. Only the first instance of this parameter is respected."
},
{
"name" : "given",
"type" : "string",
"documentation" : "A practitioner's given (first) name. When used, family is also required. Only the first instance of this parameter is respected."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "A practitioner's identifier in the format <code system>|<code>. Code system must be a URN. When this parameter is provided, all others (except _id) are ignored."
},
{
"name" : "name",
"type" : "string",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "PractitionerRole",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "email",
"type" : "token",
"documentation" : "Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored."
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "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."
},
{
"name" : "location",
"type" : "reference",
"documentation" : "Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected."
},
{
"name" : "organization",
"type" : "reference",
"documentation" : "Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected."
},
{
"name" : "phone",
"type" : "token",
"documentation" : "Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored."
},
{
"name" : "practitioner",
"type" : "reference",
"documentation" : "Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected."
},
{
"name" : "role",
"type" : "token",
"documentation" : "Refine a search for a PractitionerRole by entering a valid role. System must be included."
},
{
"name" : "specialty",
"type" : "token",
"documentation" : "Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported."
},
{
"name" : "telecom",
"type" : "token",
"documentation" : "Refine a search for a PractitionerRole for a specific telecom. System must be specified as either 'phone' or 'email'"
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Procedure",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "category",
"type" : "token",
"documentation" : "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."
},
{
"name" : "date",
"type" : "date",
"documentation" : "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."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "ProcedureRequest",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "encounter",
"type" : "reference",
"documentation" : "Search for ProcedureRequest resources for specific encounters. If not provided, all ProcedureRequest results are returned."
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "requester",
"type" : "reference",
"documentation" : "Refine a search for ProcedureRequest resources by individual making the request. By defualt, all ProcedureRequests are returned."
},
{
"name" : "status",
"type" : "token",
"documentation" : "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."
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "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."
},
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
},
{
"type" : "Schedule",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Slot",
"interaction" : [
{
"code" : "read"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported"
},
{
"type" : "Specimen",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"readHistory" : false,
"updateCreate" : false,
"conditionalCreate" : false,
"conditionalRead" : "not-supported",
"conditionalUpdate" : false,
"conditionalDelete" : "not-supported",
"searchInclude" : [
"*"
],
"searchParam" : [
{
"name" : "_id",
"type" : "token",
"documentation" : "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored."
},
{
"name" : "_count",
"type" : "number",
"documentation" : "Number of results per page."
}
]
}
]
}
]
}
IG © 2022+ HL7 Finland. Package hl7.fhir.fi.smart#1.0.0-rc7 based on FHIR 4.0.1. Generated 2023-07-03
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change