WildFHIR R4 Enterprise Edition Implementation Guide
1.0.0 - current
WildFHIR R4 Enterprise Edition Implementation Guide
1.0.0 - current
WildFHIR R4 Enterprise Edition Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://wildfhir4.aegis.net/ig/wildfhir/OperationDefinition/wildfhir-operation-load-examples | Version: 1.0.0 | |||
| Active as of 2025-03-26 | Computable Name: AEGISWildFHIRR4LoadExamples | |||
This is the WildFHIR R4 Global Load Examples operation. It provides a standardized mechanism to process all files in the specified directory folder in ascending alphanumeric order by filename and create/update them on the target WildFHIR server.
Generated Narrative: OperationDefinition wildfhir-operation-load-examples
URL: [base]/$load-examples
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | baseurl | 1..1 | string | The baseurl value is used to insure search parameter indexing for reference search parameter values is correct for the WildFHIR server's resource repository. | ||
| IN | dirpath | 1..1 | string | The dirpath value must point to a valid directory folder on the physical machine hosting the WildFHIR server. | ||
| OUT | return | 1..1 | string | If successful, the result parameter will contain a string value with further information about the load results (such as a count of resources that were loaded / skipped). If unsuccessful, the result parameter will contain a string value with a reason for the failure (e.g. reference integrity issue, security issue, or insufficient privileges). |
Implemented in AEGIS WildFHIR R4 FHIR test server - http://wildfhir4.aegis.net/fhir4-0-1
This global operation can be invoked using the GET Syntax using all parameters:
GET [base]$load-examples?{parameters}
Otherwise the POST transaction is used as follows:
POST [base]$load-examples
The operation will process all files in the specified directory folder in ascending alphanumeric order by filename and create/update them on the target WildFHIR server. In order to insure proper search parameter indexing and referential integrity please name the files such that independent resources are listed first followed by dependent resources. For example, Patient resources should be processed before Condition resources belonging to those Patient(s). Using a numeric prefix naming convention will facilitate this processing - "01-patient-example.xml", "02-condition-example.xml".
Both parameters - "baseurl" and "dirpath" - are required:
The "baseurl" parameter is needed to insure search parameter indexing for reference search parameter values is correct for the WildFHIR server's resource repository.
The "dirpath" parameter must point to a valid directory folder on the physical machine hosting the WildFHIR server.
Request the load of all example resource instances in a specific directory folder with a given FHIR server base URL for search parameter indexing using the GET syntax
GET [base]$load-examples?baseurl=http://wildfhir.aegis.net/fhir4-0-1&dirpath=C:/Temp/fhir4_0_1/examples
[other headers]
Request the load of all example resource instances in a specific directory folder with a given FHIR server base URL for search parameter indexing using the POST syntax
POST [base]$load-examples
[other headers]
POST request body:
<?xml version="1.0" encoding="UTF-8"?>
<Parameters xmlns="http://hl7.org/fhir">
<id value="parameters-load-examples-in-example"/>
<parameter>
<name value="baseurl"/>
<valueString value="http://wildfhir.aegis.net/fhir4-0-1"/>
</parameter>
<parameter>
<name value="dirpath"/>
<valueString value="C:/Temp/fhir4_0_1/examples"/>
</parameter>
</Parameters>
Response
HTTP/1.1 200 OK
[other headers]
Response body:
<?xml version="1.0" encoding="UTF-8"?>
<Parameters xmlns="http://hl7.org/fhir">
<parameter>
<name value="result"/>
<valueString value="Processing complete. 1 resources imported; 0 resources skipped."/>
</parameter>
</Parameters>