Package | hl7.fhir.us.specialty-rx |
Type | CapabilityStatement |
Id | specialty-rx-data-source-restful |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/specialty-rx/https://build.fhir.org/ig/HL7/fhir-specialty-rx/CapabilityStatement-specialty-rx-data-source-restful.html |
URL | http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-source-restful |
Version | 2.1.0 |
Status | active |
Date | 2022-07-01T00:00:00-05:00 |
Name | SpecialtyRxDataSourceRESTful |
Title | Specialty Rx CapabilityStatement - Data Source - RESTful |
Realm | us |
Authority | hl7 |
Description | This CapabilityStatement describes the expected capabilities of a server that is capable of responding to RESTful requests for patient information. |
Kind | requirements |
No resources found
StructureDefinition | |
us-core-allergyintolerance | US Core AllergyIntolerance Profile |
us-core-documentreference | US Core DocumentReference Profile |
us-core-medicationrequest | US Core MedicationRequest Profile |
us-core-observation-lab | US Core Laboratory Result Observation Profile |
specialty-rx-consent-requested | Specialty Rx ConsentRequested |
specialty-rx-consent | Specialty Rx Consent |
specialty-rx-coverage | Specialty Rx Coverage |
specialty-rx-task-consent-request | Specialty Rx Task - Consent Request |
specialty-rx-task-smart-launch | Specialty Rx Task - SMART Launch |
Note: links and images are rebased to the (stated) source
This CapabilityStatement describes the expected capabilities of a server that is capable of responding to RESTful requests for patient information.
Mode | SERVER |
Description | Specialty Rx Data Source SHALL:
Specialty Rx Data Source SHOULD:
The Specialty Rx Data Source MAY
|
Transaction | |
System History | |
System Search |
{ "resourceType": "CapabilityStatement", "id": "specialty-rx-data-source-restful", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-source-restful", "version": "2.1.0", "name": "SpecialtyRxDataSourceRESTful", "title": "Specialty Rx CapabilityStatement - Data Source - RESTful", "status": "active", "experimental": false, "date": "2022-07-01T00:00:00-05:00", "publisher": "HL7 International - Pharmacy", "contact": [ { "name": "HL7 International - Pharmacy", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/medication" } ] }, { "name": "Frank McKinney", "telecom": [ { "system": "email", "value": "frank.mckinney@pocp.com" }, { "system": "email", "value": "fm@frankmckinney.com" } ] } ], "description": "This CapabilityStatement describes the expected capabilities of a server that is capable of responding to RESTful requests for patient information.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "xml", "json" ], "patchFormat": [ "application/json-patch+json" ], "implementationGuide": [ "http://hl7.org/fhir/us/specialty-rx/ImplementationGuide/specialty-rx" ], "rest": [ { "mode": "server", "documentation": "Specialty Rx Data Source **SHALL**: \n\n1. Support the Solicited - RESTful Data Source workflow defined in this guide, including all required searches and search parameters. \n1. Implement the RESTful behavior according to the FHIR specification. \n1. Support the JSON source format. \n1. Declare a CapabilityStatement identifying the profiles supported. \n1. Follow US Core search requirements and guidance when performing searches associated with this IG. \n\nSpecialty Rx Data Source **SHOULD**: \n\n1. Respond to the Patient/$match operation. \n1. Support the recommended searches and parameters identified in the guide. \n1. Support the XML source format. \n1. Identify the Specialty Rx profiles supported as part of the FHIR `meta.profile` attribute for each applicable instance. \n\nThe Specialty Rx Data Source MAY \n\n1. Support the Task / SMART application launch capability specified in the guide. \n 1. Support the Task / Consent Request capability specified in the guide.", "security": { "description": "1. Specialty Rx Data Source **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code. \n1. Specialty Rx Data Source **SHOULD** authorize exchanges using OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Guide. \n1. For general security considerations refer to [FHIR Security and Privacy Considerations](https://www.hl7.org/fhir/secpriv-module.html). \n1. For additional security guidance, refer to the [core FHIR Security guidance page](https://www.hl7.org/fhir/security.html)." }, "resource": [ { "extension": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "clinical-status" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" } ], "type": "AllergyIntolerance", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "clinical-status", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "patient", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient", "type": "reference" } ] }, { "extension": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "onset-date" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "clinical-status" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" } ], "type": "Condition", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "category", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "clinical-status", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "patient", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "onset-date", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date", "type": "date" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "code", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code", "type": "token" } ] }, { "type": "Coverage", "profile": "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-coverage", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "patient", "definition": "http://hl7.org/fhir/SearchParameter/Coverage-patient", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "beneficiary", "definition": "http://hl7.org/fhir/SearchParameter/Coverage-beneficiary", "type": "reference" } ] }, { "extension": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "encounter" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "authoredon" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "status" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" } ], "type": "MedicationRequest", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchInclude": [ "MedicationRequest:medication" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "status", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "intent", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "patient", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "encounter", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "authoredon", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon", "type": "date" } ] }, { "extension": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "status" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" }, { "url": "required", "valueString": "date" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "code" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" } ], "type": "Observation", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "status", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "category", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "code", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "date", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date", "type": "date" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "patient", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-patient", "type": "reference" } ] }, { "extension": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" }, { "url": "required", "valueString": "period" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "type" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" }, { "url": "required", "valueString": "date" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "status" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ], "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination" } ], "type": "DocumentReference", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "documentation": "The DocumentReference.type binding SHOULD support at a minimum the 5 Common Clinical Notes defined in US Core: Discharge Summary, Consult Note, History and Physical Note, Progress Note, Procedure Note", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "search-type" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "code": "read" } ], "referencePolicy": [ "resolves" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "_id", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "status", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "patient", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "category", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "type", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type", "type": "token" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "date", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date", "type": "date" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "period", "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period", "type": "date" } ] }, { "type": "OperationOutcome", "profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ] }, { "type": "Task", "supportedProfile": [ "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-smart-launch", "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-consent-request" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ] }, { "type": "Consent", "supportedProfile": [ "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent", "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent-requested" ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "create" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "code": "update" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" } ] } ], "operation": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "patient-match", "definition": "https://www.hl7.org/fhir/operation-patient-match.html" } ] } ] }