Specialty Medication Enrollment
2.0.0-ballot - STU 2 Ballot US

This page is part of the Specialty Medication Enrollment (v2.0.0-ballot: STU2 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: Specialty Rx CapabilityStatement - Data Source - RESTful

Official URL: http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-source-restful Version: 2.0.0-ballot
Active as of 2022-07-01 Computable Name: SpecialtyRxDataSourceRESTful

This CapabilityStatement describes the expected capabilities of a server that is capable of responding to RESTful requests for patient information.

FHIR RESTful Capabilities

Specialty Rx Data Source SHALL:

  1. Support the Solicited - RESTful Data Source workflow defined in this guide, including all required searches and search parameters.
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Support the JSON source format.
  4. Declare a CapabilityStatement identifying the profiles supported.
  5. Follow US Core search requirements and guidance when performing searches associated with this IG.

Specialty Rx Data Source SHOULD:

  1. Respond to the Patient/$match operation.
  2. Support the recommended searches and parameters identified in the guide.
  3. Support the XML source format.
  4. Identify the Specialty Rx profiles supported as part of the FHIR meta.profile attribute for each applicable instance.

The Specialty Rx Data Source MAY

  1. Support the Task / SMART application launch capability specified in the guide.
  2. Support the Task / Consent Request capability specified in the guide.

Security

  1. For general security considerations refer to FHIR Security and Privacy Considerations.
  2. For additional security guidance, refer to the core FHIR Security guidance page.
  3. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

Resources

Resource Type Profile Read Search Update Create
SHALL AllergyIntolerance http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance y y
SHALL Condition http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition y y
SHALL Coverage http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-coverage y y
SHOULD DocumentReference http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference y y
SHALL MedicationRequest http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest y y
SHALL Observation http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab y y
SHALL OperationOutcome http://hl7.org/fhir/StructureDefinition/OperationOutcome y y
MAY Task http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-smart-launch y y y
MAY Task http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-consent-request y y y
MAY Consent http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent y
MAY Consent http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent-requested y

Search

Data Source systems SHALL follow US Core search requirements and guidance when performing searches associated with this guide. See the Search Conventions section.


Raw OpenAPI-Swagger Definition file | Download