FHIR Server
FHIR Version support / Pre-requisites
As of now, ART-DECOR® support FHIR server endpoints fot the following versions:
3.0 (STU 3), with the endpoint
http://serveraddress/fhir/3.0/...
4.0 (R4), with the endpoint
http://serveraddress/fhir/4.0/...
The support is provided by separate Packages that need to be installed. Please refer to the FHIR server installation instructions to learn to to set up ART-DECOR a FHIR server.
Capabilities
- Retrieve DECOR Dataset or Transaction as FHIR Logical Models
- Retrieve DECOR Templates in as FHIR Structure Definitions
- Retrieve DECOR Value Sets as FHIR Value Sets
- Retrieve DECOR Transaction as FHIR Questionnaires
- Retrieve OID Registry info as FHIR Naming System
URI Patterns
All calls to ART-DECOR's FHIR features are to be made through FHIR version-aware endpoints.
All URIs are using the following construct.
Pattern Overview
http://serveraddress/fhir/[version]/[channel]/[resource]/[id]
Base URI
http://serveraddress/fhir/
Version Identifier
FHIR Version, one of the following
| FHIR Version | Identifer to use in URI |
|---|---|
| DSTU 2 | 1.0 |
| STU 3 | 3.0 |
| R 4 | 4.0 |
Channel
The following channels are supported
| Description | Channel Identifier |
|---|---|
| Trying to find the requested resource anywhere on the server | public |
| Project prefix limits scope to the requested DECOR project | project prefix, e.g. demo1- |
| Project prefix + release version limits scope to the requested DECOR project release | project prefix + release version as digits, e.g. demo1-20151105100336 |
| OID Registry name limits scope to the requested OID Registry | OID Registry name, e.g. hl7org |
Resource
The [resource] you would like to retrieve, e.g. StructureDefinition, ValueSet, NamingSystem
Identifier
The id for the resource you would like to retrieve. For NamingSystem, just use the OID. For other DECOR objects, use the id--effectiveDate where you strip non-digits from the effectiveDate
Examples
Dataset or Transaction
Get the logical model for the object from any live DECOR project that has it. Any Dataset or Transaction will work, in this case the demo1- dataset.
http://art-decor.org/fhir/4.0/public/StructureDefinition/2.16.840.1.113883.3.1937.99.62.3.1.1--20120530113236
Template
Get the Template with id xxxxx and version yyyyy from the live DECOR demo5- project.
http://art-decor.org/fhir/4.0/demo5-/StructureDefinition/
Value Set
Get Value Set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the live DECOR demo1- project.
http://art-decor.org/fhir/4.0/demo5-/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256
Get Value Set with id 2.16.840.1.113883.3.1937.99.62.3.11.5 and version 2011-07-25T15:22:56 from the DECOR demo1- project release 2015-11-05T10:03:36.
http://art-decor.org/fhir/4.0/demo1-20151105100336/ValueSet/2.16.840.1.113883.3.1937.99.62.3.11.5--20110725152256
Questionnaire
Get FHIR Questionnaire derived from Transaction id xxxxx and version yyyyy from the live DECOR demo5- project.
Naming System
Get the naming system for SNOMED CT from the HL7 OID Registry.
http://art-decor.org/fhir/4.0/hl7org/NamingSystem/2.16.840.1.113883.6.96