Package | hl7.fhir.us.illTraveler |
Type | CapabilityStatement |
Id | IllTravelerReportCapabilityStatement |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/reportofilltraveler/https://build.fhir.org/ig/HL7/ReportIIITraveler-ig/CapabilityStatement-IllTravelerReportCapabilityStatement.html |
URL | http://hl7.org/fhir/us/reportofilltraveler/CapabilityStatement/IllTravelerReportCapabilityStatement |
Version | 0.1.0 |
Status | draft |
Date | 2024-01-12 |
Name | IllTravelerReportCapabilityStatement |
Title | Report of Ill Traveler API CapabilityStatement |
Realm | us |
Authority | hl7 |
Description | Ill Traveler Report CapabilityStatement |
Kind | requirements |
No resources found
ImplementationGuide | |
hl7.fhir.us.illTraveler | CDC DGMH Report of Ill Traveler |
Note: links and images are rebased to the (stated) source
xml
, json
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.
server
A ill Traveler API SHALL:
meta.profile
attribute for each instance.
- See the General Security Considerations section for requirements and recommendations.
- A server SHALL reject any unauthorized requests by returning an
HTTP 401
unauthorized response code.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|
Composition | Supported profiles: http://hl7.org/fhir/us/reportofilltraveler/ImplementationGuide/hl7.fhir.us.illTraveler | y | y |
{ "resourceType": "CapabilityStatement", "id": "IllTravelerReportCapabilityStatement", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "http://hl7.org/fhir/us/reportofilltraveler/CapabilityStatement/IllTravelerReportCapabilityStatement", "version": "0.1.0", "name": "IllTravelerReportCapabilityStatement", "title": "Report of Ill Traveler API CapabilityStatement", "status": "draft", "date": "2024-01-12", "publisher": "HL7 Public Health Working Group", "contact": [ { "name": "HL7 Public Health Working Group", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pher" }, { "system": "email", "value": "pafm@lists.HL7.org" } ] } ], "description": "Ill Traveler Report CapabilityStatement", "kind": "requirements", "fhirVersion": "4.0.1", "format": [ "xml", "json" ], "rest": [ { "mode": "server", "documentation": "A ill Traveler API **SHALL**:\n\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support json and xml source formats for all interactions.\n1. Identify the profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n1. Support the searchParameters on each profile individually and in combination.\n", "security": { "description": "1. See the [General Security Considerations](https://www.hl7.org/fhir/security.html#general) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code." }, "resource": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "type": "Composition", "supportedProfile": [ "http://hl7.org/fhir/us/reportofilltraveler/ImplementationGuide/hl7.fhir.us.illTraveler" ], "_supportedProfile": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ] } ], "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "search-type" } ] } ] } ] }