CDC DGMH Report of Ill Traveler
0.1.0 - ci-build

CDC DGMH Report of Ill Traveler, published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ReportIIITraveler-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: Report of Ill Traveler API CapabilityStatement

Official URL: http://hl7.org/fhir/us/reportofilltraveler/CapabilityStatement/IllTravelerReportCapabilityStatement Version: 0.1.0
Draft as of 2024-01-12 Computable Name: IllTravelerReportCapabilityStatement

Ill Traveler Report CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

Report of Ill Traveler API CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Fri Jan 12 00:00:00 UTC 2024
  • Published by: HL7 Public Health Working Group

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.

FHIR RESTful Capabilities

Mode: server

A ill Traveler API SHALL:

  1. Implement the RESTful behavior according to the FHIR specification.
  2. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • (Status 404): unknown resource
    • (Status 410): deleted resource.
  3. Support json and xml source formats for all interactions.
  4. Identify the profiles supported as part of the FHIR meta.profile attribute for each instance.
  5. Support the searchParameters on each profile individually and in combination.
Security
  1. See the General Security Considerations section for requirements and recommendations.
  2. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.
Summary of System-wide Interactions

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
CompositionSupported profiles:
  http://hl7.org/fhir/us/reportofilltraveler/ImplementationGuide/hl7.fhir.us.illTraveler		yy

Resource Conformance: SHALLComposition

Core FHIR Resource
Composition
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

​http://hl7.org/fhir/us/reportofilltraveler/ImplementationGuide/hl7.fhir.us.illTraveler