Specialty Medication Enrollment
2.0.0 - STU2 US United States of America flag

This page is part of the Specialty Medication Enrollment (v2.0.0: STU2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

CapabilityStatement: Specialty Rx CapabilityStatement - Data Consumer - RESTful

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

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.

FHIR RESTful Capabilities

Specialty Rx Data Consumer SHALL:

  1. Support the RESTful solicited 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 Consumer SHOULD:

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

The Specialty Rx Data Consumer 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.

Resources

Resource Type Profile Read Search Update Create
SHOULD AllergyIntolerance http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance y y
SHOULD Condition http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition y y
SHOULD 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
SHOULD MedicationRequest http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest y y
SHOULD 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 Consumer 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