{
"description": null,
"_filename": "example/CapabilityStatement-apottiekosysteemi-capabilitystatement.json",
"package_name": "hl7.fhir.fi.smart",
"format": [ "xml", "json" ],
"date": "2023-01-17T10:35:03Z",
"meta": {
"profile": [ "https://hl7.fi/fhir/finnish-smart/StructureDefinition/fi-smart-server-profile" ]
},
"publisher": "HL7 Finland",
"fhirVersion": "3.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "FI",
"system": "urn:iso:std:iso:3166",
"display": "Finland"
} ]
} ],
"name": null,
"copyright": "Copyright Epic 1979-2022",
"type": null,
"experimental": "true",
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "1.0.0-rc2",
"status": "active",
"id": "95a73f3d-97b4-46a4-a7d7-4f1c6b361947",
"kind": "instance",
"url": "https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apottiekosysteemi-capabilitystatement",
"software": {
"name": "Epic",
"version": "toukokuu 2022",
"releaseDate": "2022-09-12"
},
"version": "1.0.0-rc2",
"contact": [ {
"name": "HL7 Finland",
"telecom": [ {
"value": "https://www.hl7.fi/",
"system": "url"
}, {
"value": "mikael@sensotrend.com",
"system": "email"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "AllergyIntolerance",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Appointment",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"type": "Binary",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Condition",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Consent",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Coverage",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Device",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "DeviceRequest",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "DeviceUseStatement",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "DiagnosticReport",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "DocumentReference",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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 |"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Encounter",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"type": "Endpoint",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Flag",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Goal",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Immunization",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "ImmunizationRecommendation",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "List",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"type": "Location",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"type": "Medication",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "MedicationDispense",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "MedicationRequest",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "MedicationStatement",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "NutritionOrder",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Observation",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
}, {
"code": "update"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"type": "Organization",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"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 {|} or {|}."
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Patient",
"interaction": [ {
"code": "create"
}, {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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 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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Practitioner",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "PractitionerRole",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Procedure",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "ProcedureRequest",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
}, {
"type": "Schedule",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"type": "Slot",
"interaction": [ {
"code": "read"
} ],
"readHistory": false,
"updateCreate": false,
"conditionalRead": "not-supported",
"conditionalCreate": false,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"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."
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Specimen",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": false,
"searchInclude": [ "*" ],
"conditionalDelete": "not-supported"
} ],
"security": {
"cors": true,
"service": [ {
"text": "OAuth",
"coding": [ {
"code": "OAuth",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "OAuth"
} ]
}, {
"text": "SMART-on-FHIR",
"coding": [ {
"code": "SMART-on-FHIR",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "SMART-on-FHIR"
} ]
}, {
"text": "Basic",
"coding": [ {
"code": "Basic",
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"display": "Basic"
} ]
} ],
"extension": [ {
"url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
"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"
} ]
} ]
}
} ]
}