# HeyDonto FHIR R4 API - Implementer Support The Implementation Support Module provides information which will be useful for FHIR implementers, including information about available libraries, tools, and other similar resources, as well as where to seek help. --- ## Index In addition to the content below, a number of implementation resources can be found on the [Downloads Page](https://hl7.org/fhir/R4/downloads.html). This module also contains specific documentation that relates to issues commonly encountered by developers: * [Testing FHIR](https://hl7.org/fhir/R4/testing.html) + [TestScript](https://hl7.org/fhir/R4/testscript.html) + [TestReport](https://hl7.org/fhir/R4/testreport.html) * [Validating Resources](https://hl7.org/fhir/R4/validation.html) * [Mapping Language](https://hl7.org/fhir/R4/mapping-language.html) ([Tutorial](https://hl7.org/fhir/R4/mapping-tutorial.html) & [StructureMap](https://hl7.org/fhir/R4/structuremap.html)) * [FHIRPath](https://hl7.org/fhir/R4/fhirpath.html) * [Common Usages](https://hl7.org/fhir/R4/usecases.html) * [Version Management Policy](https://hl7.org/fhir/R4/versions.html) * [Clinical Safety Considerations](https://hl7.org/fhir/R4/safety.html) * [How FHIR fits into an EHR](https://hl7.org/fhir/R4/ehr-fm.html) * [Managing Resource Identity](https://hl7.org/fhir/R4/managing.html) * [Interaction Patterns](https://hl7.org/fhir/R4/pushpull.html) * [Update Rules](https://hl7.org/fhir/R4/updates.html) * [Clinical Examples](https://hl7.org/fhir/R4/integrated-examples.html) * [Comparisons](https://hl7.org/fhir/R4/comparison.html): * [v2](https://hl7.org/fhir/R4/comparison-v2.html) * [v3 Messaging](https://hl7.org/fhir/R4/comparison-v3.html) * [CDA](https://hl7.org/fhir/R4/comparison-cda.html) + [CDA on FHIR](https://hl7.org/fhir/R4/cda-intro.html) * [Other Specifications](https://hl7.org/fhir/R4/comparison-other.html) --- ## Security and Privacy For more general considerations, see [the Security and Privacy module](https://hl7.org/fhir/R4/secpriv-module.html). --- ## Common Use Cases ### For Client Developers and Testers: Reference Servers The following reference servers have been created by the FHIR team and made available to help implementers test their code. While the reference servers are not considered to be a normative part of the FHIR specification, the maintainers make every effort to ensure that they are fully compliant. Note that there are a large number of servers available for testing that are not listed here. A full list is available on the HL7 Confluence system [here](https://confluence.hl7.org/display/FHIR/Public+Test+Servers). | Server Name | Maintainer | Link | |-------------|------------|------| | Healthintersections | Grahame Grieve | [http://fhir3.healthintersections.com.au/](http://fhir3.healthintersections.com.au/) | | Spark | Furore Informatica | [http://spark.furore.com/](http://spark.furore.com/) | | HAPI | University Health Network / James Agnew | [http://fhirtest.uhn.ca/](http://fhirtest.uhn.ca/) | | sqlonfhir | Telstra Health / Brian Postlethwaite | [http://sqlonfhir-stu3.azurewebsites.net/fhir](http://sqlonfhir-stu3.azurewebsites.net/fhir) | ### For Developers: Reference Implementations (Libraries) The following reference implementations are made available under an open-source license. These libraries may be used by developers to quickly add FHIR capabilities to their applications. | Language | Library | Link | License | |----------|---------|------|---------| | .NET / C# | FHIR .NET API | [https://github.com/ewoutkramer/fhir-net-api](https://github.com/ewoutkramer/fhir-net-api) | BSD-3 | | Java | HAPI FHIR | [http://hapifhir.io](http://hapifhir.io) | Apache 2.0 | | Swift | Swift FHIR | [https://github.com/smart-on-fhir/Swift-FHIR](https://github.com/smart-on-fhir/Swift-FHIR) | Apache 2.0 | | JavaScript | fhir.js | [https://github.com/smart-on-fhir/fhir.js](https://github.com/smart-on-fhir/fhir.js) | MIT | | Python | Client Py | [https://github.com/smart-on-fhir/client-py](https://github.com/smart-on-fhir/client-py) | Apache 2.0 | | Pascal | FHIR Pascal | [http://hl7.org/fhir/downloads.html](http://hl7.org/fhir/downloads.html) | BSD-3 | ### For Profilers A number of tools are available to profilers wishing to create profiles for use in their implementations. A current list of tools can be found [here](https://confluence.hl7.org/pages/viewpage.action?pageId=35718864#ProfileTooling-Editing&AuthoringProfiles) on HL7 Confluence. (See the [conformance module](https://hl7.org/fhir/R4/conformance-module.html) for information on profiling.) ### For Testers A number of tools are available to solution testers who want to test FHIR implementations for conformance to the FHIR specification. A current list of such tools can be found [here](https://confluence.hl7.org/display/FHIR/Testing+Platforms). --- ## Getting Help The following are a few ways that implementers can seek help as they work with FHIR: * [FHIR Chat Channel / Zulip](http://chat.fhir.org/) (maintained by fhir.org) * [FHIR Community Forum](http://community.fhir.org/) (maintained by fhir.org) * [StackOverflow](http://stackoverflow.com/questions/tagged/hl7_fhir) (General tech community, use the tag `hl7_fhir`) --- ## Developmental Roadmap The reference servers and reference implementations generally try to keep up to date with recent changes to the FHIR specification. Each server may have multiple endpoints which are held to a specific version of the specification, but generally there will also be endpoints available for testing which conform to a very recent build. Efforts are now underway to create a curated collection of quality test data which can be used by FHIR implementers to help test their applications. This collection will be made available when it is ready. Version: 1.0 ## Servers Sandbox ``` https://api-staging.heydonto.com ``` Production ``` https://api.heydonto.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [HeyDonto FHIR R4 API - Implementer Support](https://docs.heydonto.com/_bundle/apis/fhir/implementer-support.yaml) ## CompartmentDefinition ### Get FHIR r4 compartment definitions - [GET /site/{siteId}/fhir/compartment-definition](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_getcompartmentdefinitions.md) ### Create FHIR r4 compartment definition - [POST /site/{siteId}/fhir/compartment-definition](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_createcompartmentdefinition.md) ### Get FHIR r4 compartment definition by ID - [GET /site/{siteId}/fhir/compartment-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_getcompartmentdefinition.md) ### Update FHIR r4 compartment definition - [PUT /site/{siteId}/fhir/compartment-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_updatecompartmentdefinition.md) ### Delete FHIR r4 compartment definition - [DELETE /site/{siteId}/fhir/compartment-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_deletecompartmentdefinition.md) ### Get FHIR r4 compartment definition history by ID - [GET /site/{siteId}/fhir/compartment-definition/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/compartmentdefinition/fhircompartmentdefinitioncontroller_getcompartmentdefinitionhistory.md) ## ExampleScenario ### Get FHIR r4 example scenarios - [GET /site/{siteId}/fhir/example-scenario](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_getexamplescenarios.md) ### Create FHIR r4 example scenario - [POST /site/{siteId}/fhir/example-scenario](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_createexamplescenario.md) ### Get FHIR r4 example scenario by ID - [GET /site/{siteId}/fhir/example-scenario/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_getexamplescenario.md) ### Update FHIR r4 example scenario - [PUT /site/{siteId}/fhir/example-scenario/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_updateexamplescenario.md) ### Delete FHIR r4 example scenario - [DELETE /site/{siteId}/fhir/example-scenario/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_deleteexamplescenario.md) ### Get FHIR r4 example scenario history by ID - [GET /site/{siteId}/fhir/example-scenario/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/examplescenario/fhirexamplescenariocontroller_getexamplescenariohistory.md) ## GraphDefinition ### Get FHIR r4 graph definitions - [GET /site/{siteId}/fhir/graph-definition](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_getgraphdefinitions.md) ### Create FHIR r4 graph definition - [POST /site/{siteId}/fhir/graph-definition](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_creategraphdefinition.md) ### Get FHIR r4 graph definition by ID - [GET /site/{siteId}/fhir/graph-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_getgraphdefinition.md) ### Update FHIR r4 graph definition - [PUT /site/{siteId}/fhir/graph-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_updategraphdefinition.md) ### Delete FHIR r4 graph definition - [DELETE /site/{siteId}/fhir/graph-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_deletegraphdefinition.md) ### Get FHIR r4 graph definition history by ID - [GET /site/{siteId}/fhir/graph-definition/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/graphdefinition/fhirgraphdefinitioncontroller_getgraphdefinitionhistory.md) ## ImplementationGuide ### Get FHIR r4 implementation guides - [GET /site/{siteId}/fhir/implementation-guide](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_getimplementationguides.md) ### Create FHIR r4 implementation guide - [POST /site/{siteId}/fhir/implementation-guide](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_createimplementationguide.md) ### Get FHIR r4 implementation guide by ID - [GET /site/{siteId}/fhir/implementation-guide/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_getimplementationguide.md) ### Update FHIR r4 implementation guide - [PUT /site/{siteId}/fhir/implementation-guide/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_updateimplementationguide.md) ### Delete FHIR r4 implementation guide - [DELETE /site/{siteId}/fhir/implementation-guide/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_deleteimplementationguide.md) ### Get FHIR r4 implementation guide history by ID - [GET /site/{siteId}/fhir/implementation-guide/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/implementationguide/fhirimplementationguidecontroller_getimplementationguidehistory.md) ## StructureDefinition ### Get FHIR r4 structure definitions - [GET /site/{siteId}/fhir/structure-definition](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_getstructuredefinitions.md) ### Create FHIR r4 structure definition - [POST /site/{siteId}/fhir/structure-definition](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_createstructuredefinition.md) ### Get FHIR r4 structure definition by ID - [GET /site/{siteId}/fhir/structure-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_getstructuredefinition.md) ### Update FHIR r4 structure definition - [PUT /site/{siteId}/fhir/structure-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_updatestructuredefinition.md) ### Delete FHIR r4 structure definition - [DELETE /site/{siteId}/fhir/structure-definition/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_deletestructuredefinition.md) ### Get FHIR r4 structure definition history by ID - [GET /site/{siteId}/fhir/structure-definition/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/structuredefinition/fhirstructuredefinitioncontroller_getstructuredefinitionhistory.md) ## StructureMap ### Get FHIR r4 structure maps - [GET /site/{siteId}/fhir/structure-map](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_getstructuremaps.md) ### Create FHIR r4 structure map - [POST /site/{siteId}/fhir/structure-map](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_createstructuremap.md) ### Get FHIR r4 structure map by ID - [GET /site/{siteId}/fhir/structure-map/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_getstructuremap.md) ### Update FHIR r4 structure map - [PUT /site/{siteId}/fhir/structure-map/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_updatestructuremap.md) ### Delete FHIR r4 structure map - [DELETE /site/{siteId}/fhir/structure-map/{id}](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_deletestructuremap.md) ### Get FHIR r4 structure map history by ID - [GET /site/{siteId}/fhir/structure-map/{id}/history](https://docs.heydonto.com/apis/fhir/implementer-support/structuremap/fhirstructuremapcontroller_getstructuremaphistory.md)