Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir.athena.io/OperationDefinition/ah-group-export | Version: 4.2.0 | |||
Active as of 2025-04-17 | Computable Name: AthenahealthGroupLevelExport |
FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group. The FHIR server SHALL support invocation of this operation using the FHIR Asynchronous Request Pattern.
This OperationDefinition is a profile of the base group-export (v1.0.1) that limits the supported parameters.
Generated Narrative: OperationDefinition ah-group-export
Information Source: athenacoreext
URL: [base]/Group/[id]/$export
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | _outputFormat | 0..1 | string | The format for the requested bulk data files to be generated as per FHIR Asynchronous Request Pattern. Defaults to | ||
IN | _type | 0..1 | string | A string of comma-delimited FHIR resource types. Only resources of the specified resource types(s) SHOULD be included in the response. If this parameter is omitted, the server SHOULD return all supported resources within the scope of the client authorization. For non-system-level requests, the Patient Compartment SHOULD be used as a point of reference for recommended resources to be returned as well as other resources outside of the patient compartment that are helpful in interpreting the patient data such as Organization and Practitioner. Resource references MAY be relative URIs with the format {resource type}/{id}, or absolute URIs with the same structure rooted in the base URI for the server from which the export was performed. References will be resolved looking for a resource with the specified type and id within the file set. Note: Implementations MAY limit the resources returned to specific subsets of FHIR, such as those defined in the Argonaut Implementation Guide. | ||
IN | _since | 0..1 | instant | Resources will be included in the response if their state has changed after the supplied time (e.g., if Resource.meta.lastUpdated is later than the supplied _since time). In the case of a Group level export, the server MAY return additional resources modified prior to the supplied time if the resources belong to the patient compartment of a patient added to the Group after the supplied time (this behavior SHOULD be clearly documented by the server). |