Generated Narrative: CapabilityStatement uapi-gne-fhir-server

UAPI CapabilityStatement - Genentech FHIR Server

  • Implementation Guide Version: 1.1.20
  • FHIR Version: 4.3.0
  • Supported Formats: xml, json
  • Supported Patch Formats: application/json-patch+json
  • Published on: 2020-08-21 00:00:00-0500

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

  • https://fhir.developer.gene.com/ImplementationGuide/uapi

FHIR RESTful Capabilities

Mode: server

UAPI 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.

UAPI 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 UAPI profiles supported as part of the FHIR meta.profile attribute for each applicable instance.

The UAPI Data Source MAY

  1. Support the Task / SMART application launch capability specified in the guide.
Security
  1. UAPI Data Source SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
  2. UAPI Data Source SHOULD authorize exchanges using OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Guide.
  3. For general security considerations refer to FHIR Security and Privacy Considerations.
  4. For additional security guidance, refer to the core FHIR Security guidance page.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Questionnairehttp://hl7.org/fhir/StructureDefinition/QuestionnaireYYname, version

Resource Conformance: SHALL Questionnaire

Base System Profile
Questionnaire
Profile Conformance
SHALL
Reference Policy
resolves

Interaction summary
  • SHALL support search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALLversiontoken
 
 <status value="active"/> <experimental value="false"/> <date value="2020-08-21T00:00:00-05:00"/> <contact> <name value="Krzysztof Wilczek"/> <telecom> <system value="email"/> <value value="mailto:wilczekk@gene.com"/> </telecom> </contact> <description value="This CapabilityStatement describes the capabilities of a Genentech FHIR server which receives patient enrollments, sends enrollment status updates and serves related Questionnaire resources."/> <kind value="requirements"/> <fhirVersion value="4.3.0"/> <format value="xml"/> <format value="json"/> <patchFormat value="application/json-patch+json"/> <implementationGuide value="https://fhir.developer.gene.com/ImplementationGuide/uapi"/> <rest> <mode value="server"/> <documentation value="UAPI Data Source **SHALL**: 1. Support the Solicited - RESTful Data Source workflow defined in this guide, including all required searches and search parameters. 1. Implement the RESTful behavior according to the FHIR specification. 1. Support the JSON source format. 1. Declare a CapabilityStatement identifying the profiles supported. 1. Follow US Core search requirements and guidance when performing searches associated with this IG. UAPI Data Source **SHOULD**: 1. Respond to the Patient/$match operation. 1. Support the recommended searches and parameters identified in the guide. 1. Support the XML source format. 1. Identify the UAPI profiles supported as part of the FHIR `meta.profile` attribute for each applicable instance. The UAPI Data Source MAY 1. Support the Task / SMART application launch capability specified in the guide."/> <security> <description value="1. UAPI Data Source **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code. 1. UAPI Data Source **SHOULD** authorize exchanges using OAuth 2.0 access management in accordance with the SMART Backend Services Authorization Guide. 1. For general security considerations refer to [FHIR Security and Privacy Considerations](https://www.hl7.org/fhir/secpriv-module.html). 1. For additional security guidance, refer to the [core FHIR Security guidance page](https://www.hl7.org/fhir/security.html)."/> </security> <resource> <type value="Questionnaire"/> <profile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> </interaction> <referencePolicy value="resolves"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="version"/> <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-version"/> <type value="token"/> </searchParam> </resource> </rest> </CapabilityStatement>