{ "description": "This CapabilityStatement describes the expected capabilities of a system that is capable of executing RESTful operations to retrieve patient information from a RESTful FHIR server.", "_filename": "CapabilityStatement-specialty-rx-data-recipient-restful.json", "package_name": "hl7.fhir.us.specialty-rx", "format": [ "xml", "json" ], "date": "2020-11-19T00:00:00-05:00", "publisher": "HL7 International - Pharmacy", "patchFormat": [ "application/json-patch+json" ], "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166", "display": "United States of America" } ] } ], "name": "SpecialtyRxDataRecipientRestful", "type": null, "experimental": "false", "resourceType": "CapabilityStatement", "title": "Specialty Rx CapabilityStatement - Data Recipient - RESTful", "package_version": "0.1.0", "status": "active", "id": "1717751f-bd29-410f-a33a-27c437179442", "kind": "requirements", "implementationGuide": [ "http://hl7.org/fhir/us/specialty-rx/ImplementationGuide/specialty-rx" ], "url": "http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-recipient-restful", "version": "0.1.0", "contact": [ { "name": "HL7 International - Pharmacy", "telecom": [ { "value": "http://www.hl7.org/Special/committees/medication", "system": "url" } ] }, { "name": "Frank McKinney", "telecom": [ { "value": "frank.mckinney@pocp.com", "system": "email" } ] } ], "rest": [ { "mode": "client", "resource": [ { "type": "AllergyIntolerance", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "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" } ] } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "searchParam": [ { "name": "clinical-status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-patient" } ] }, { "type": "Condition", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "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": "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" } ] } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "searchParam": [ { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category" }, { "name": "clinical-status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-patient" }, { "name": "onset-date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code" } ] }, { "type": "Coverage", "profile": "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-coverage", "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "searchParam": [ { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/Coverage-patient" }, { "name": "beneficiary", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/SearchParameter/Coverage-beneficiary" } ] }, { "type": "MedicationRequest", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "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": "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": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "intent" }, { "url": "required", "valueString": "status" } ] } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status" }, { "name": "intent", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-patient" }, { "name": "encounter", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-encounter" }, { "name": "authoredon", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon" } ], "searchInclude": [ "MedicationRequest:medication" ], "referencePolicy": [ "resolves" ] }, { "type": "Observation", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "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": "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": "SHOULD" }, { "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": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ], "searchParam": [ { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status" }, { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category" }, { "name": "code", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date" } ] }, { "type": "DocumentReference", "profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" }, { "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": "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": "SHOULD" }, { "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": "SHOULD" }, { "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": "SHOULD" }, { "url": "required", "valueString": "patient" }, { "url": "required", "valueString": "category" } ] } ], "interaction": [ { "code": "search-type", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "searchParam": [ { "name": "_id", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id" }, { "name": "status", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status" }, { "name": "patient", "type": "reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient" }, { "name": "category", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category" }, { "name": "type", "type": "token", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type" }, { "name": "date", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date" }, { "name": "period", "type": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period" } ], "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" }, { "type": "OperationOutcome", "profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "interaction": [ { "code": "create", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] }, { "code": "read", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ] }, { "type": "Task", "profile": "http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-smart-launch", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "interaction": [ { "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", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ] } ] } ], "security": { "description": "1. For general security considerations refer to [FHIR Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For additional security guidance, refer to the [core FHIR Security guidance page](https://www.hl7.org/fhir/security.html)." }, "operation": [ { "name": "patient-match", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "definition": "https://www.hl7.org/fhir/operation-patient-match.html" } ], "documentation": "Specialty Rx Data Recipient **SHALL**: \n\n1. Support the RESTful solicited 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. \n\nSpecialty Rx Data Recipient **SHOULD**: \n\n1. Support the Patient/$match operation. \n1. Support the recommended searches and parameters identified in the guide. \n1. Identify the Specialty Rx profiles supported as part of the FHIR `meta.profile` attribute for each applicable instance. \n\nThe Specialty Rx Data Recipient MAY \n\n1. Support the Task / SMART application launch capability specified in the guide." } ] }