{
"description": "This is the FHIR capability statement for the MI Repository Query",
"_filename": "CapabilityStatement-MI-server-query.json",
"package_name": "ontariomicdrfhirimplementationguide",
"format": [ "json", "xml" ],
"date": "2023-05-25",
"publisher": "Ontario Health",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CA",
"system": "urn:iso:std:iso:3166",
"display": "Canada"
} ]
} ],
"purpose": "Main EHR capability statement, published for contracting and operational support",
"name": "MICapabilityQuery",
"copyright": "Copyright © Ontario Health",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": "MI Repository Query FHIR Capability Statement",
"package_version": "0.10.00-0.9.10-beta",
"status": "draft",
"id": "c8205240-104e-415a-aa7b-486d2435f3b1",
"kind": "capability",
"url": "http://ontariohealth.ca/fhir/CapabilityStatement/mi-server-query",
"software": {
"name": "Ontario MI CDR FHIR R4 API"
},
"version": null,
"contact": [ {
"name": "Ontario Health",
"telecom": [ {
"value": "DigitalHealthStandards@ontariohealth.ca",
"system": "email"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "DiagnosticReport",
"interaction": [ {
"code": "search-type",
"documentation": "Search DiagnosticReport resources using specified parameters. Supports both GET and POST operation"
}, {
"code": "read",
"documentation": "Read interaction to retrieve a specific MI report by specifying a resource id"
}, {
"code": "vread",
"documentation": "Version read interaction to retrieve a specific MI report version by specifying a resource id and version"
} ],
"searchParam": [ {
"name": "patient.identifier",
"type": "token",
"definition": "http://ontariohealth.ca/fhir/SearchParameter/ca-on-medications-patient-identifier",
"documentation": "Supports search by Ontario Health Number or Medical Record Number. Patient identifier is a mandatory search parameter."
}, {
"name": "issued",
"type": "date",
"documentation": "When the report was issued"
}, {
"name": "code",
"type": "token",
"documentation": "MI procedure code (local, provincial or SNOMED CT)"
}, {
"name": "category",
"type": "token",
"documentation": "Category code, e.g. modality, specialty, bodypart, etc."
}, {
"name": "_mdm",
"type": "token",
"documentation": "Indicates if a call to PCR has occurred prior to the search operation. Default value is 'true' if not provided. _mdm=true means all patients' record linked to the patient in the search parameters will be returned."
} ],
"documentation": "Retrieve history of patient's MI reports",
"searchInclude": [ "DiagnosticReport:based-on", "DiagnosticReport:encounter", "DiagnosticReport:patient", "DiagnosticReport:performer", "DiagnosticReport:result", "DiagnosticReport:results-interpreter" ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mi-profile-diagnosticreport" ]
}, {
"type": "ServiceRequest",
"interaction": [ {
"code": "search-type",
"documentation": "Search ServiceRequest resources using specified parameters. Supports both GET and POST operation"
}, {
"code": "read",
"documentation": "Read interaction to retrieve a specific MI order by specifying a resource ID"
}, {
"code": "vread",
"documentation": "Version read interaction to retrieve a specific MI order version by specifying a resource id and version"
} ],
"searchParam": [ {
"name": "patient.identifier",
"type": "token",
"definition": "http://ontariohealth.ca/fhir/SearchParameter/ca-on-medications-patient-identifier",
"documentation": "Supports search by Ontario Health Number or Medical Record Number. Patient identifier is a mandatory search parameter."
}, {
"name": "authored",
"type": "date",
"documentation": "Date MI order was signed"
}, {
"name": "code",
"type": "token",
"documentation": "MI procedure code (local, provincial or SNOMED CT)"
}, {
"name": "category",
"type": "token",
"documentation": "Category code, e.g. modality, specialty, bodypart, etc."
}, {
"name": "_mdm",
"type": "token",
"documentation": "Indicates if a call to PCR has occurred prior to the search operation. Default value is 'true' if not provided. _mdm=true means all patients' record linked to the patient in the search parameters will be returned."
} ],
"documentation": "Retrieve history of patient's MI orders",
"searchInclude": [ "ServiceRequest:based-on", "ServiceRequest:encounter", "ServiceRequest:patient", "ServiceRequest:performer", "ServiceRequest:replaces", "ServiceRequest:requester" ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mi-profile-servicerequest" ]
}, {
"type": "ImagingStudy",
"interaction": [ {
"code": "search-type",
"documentation": "Search ImagingStudy resources using specified parameters. Supports both GET and POST operation"
}, {
"code": "read",
"documentation": "Read interaction to retrieve a specific image manifest by specifying a resource ID"
}, {
"code": "vread",
"documentation": "Version read interaction to retrieve a specific image manifest version by specifying a resource id and version"
} ],
"searchParam": [ {
"name": "patient.identifier",
"type": "token",
"definition": "http://ontariohealth.ca/fhir/SearchParameter/ca-on-medications-patient-identifier",
"documentation": "Supports search by Ontario Health Number or Medical Record Number. Patient identifier is a mandatory search parameter."
}, {
"name": "started",
"type": "date",
"documentation": "When the study was started"
}, {
"name": "category",
"type": "token",
"documentation": "Category code, e.g. procedure code (local, provincial or SNOMED CT), modality, specialty, bodypart, etc."
}, {
"name": "_mdm",
"type": "token",
"documentation": "Indicates if a call to PCR has occurred prior to the search operation. Default value is 'true' if not provided. _mdm=true means all patients' record linked to the patient in the search parameters will be returned."
} ],
"documentation": "Retrieve history of patient's image manifests",
"searchInclude": [ "ImagingStudy:basedon", "ImagingStudy:encounter", "ImagingStudy:interpreter", "ImagingStudy:patient", "ImagingStudy:performer", "ImagingStudy:referrer" ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mi-profile-imagingstudy" ]
}, {
"type": "DocumentReference",
"operation": [ {
"name": "docref",
"definition": "http://hl7.org/fhir/us/core/OperationDefinition/docref",
"documentation": "A server **SHALL** be capable of responding to a $docref operation and capable of returning references to MI orders, reports, and image manifests\n\n`GET [base]/DocumentReference/$docref?patient=[id]`"
} ],
"interaction": [ {
"code": "search-type",
"documentation": "Search DocumentReference resources using specified parameters. Supports both GET and POST operation"
}, {
"code": "read",
"documentation": "Read interaction to retrieve a specific document reference by specifying a resource ID"
}, {
"code": "vread",
"documentation": "Version read interaction to retrieve a specific document reference version by specifying a resource id and version"
} ],
"searchParam": [ {
"name": "patient.identifier",
"type": "token",
"definition": "http://ontariohealth.ca/fhir/SearchParameter/ca-on-medications-patient-identifier",
"documentation": "Supports search by Ontario Health Number or Medical Record Number. Patient identifier is a mandatory search parameter."
}, {
"name": "date",
"type": "date",
"documentation": "When this document reference was created"
}, {
"name": "type",
"type": "token",
"documentation": "Kind of document (local or LOINC)"
}, {
"name": "category",
"type": "token",
"documentation": "Category code, e.g. procedure code (local, provincial or SNOMED CT), modality, specialty, bodypart, etc."
}, {
"name": "_mdm",
"type": "token",
"documentation": "Indicates if a call to PCR has occurred prior to the search operation. Default value is 'true' if not provided. _mdm=true means all patients' record linked to the patient in the search parameters will be returned."
} ],
"documentation": "Retrieve history of patient's document references",
"searchInclude": [ "DocumentReference:author", "DocumentReference:encounter", "DocumentReference:patient" ],
"referencePolicy": [ "resolves" ],
"supportedProfile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mi-profile-documentreference" ]
} ],
"documentation": "Support retrieval of patient's MI records"
} ]
}