Health Connect Australia Provider Directory FHIR Implementation Guide
26.0.0
Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD/ and changes regularly. See the Directory of published versions
| Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters | Version: 26.0.0 | |||
| Active as of 2026-11-03 | Computable Name: HCPD_Export_Request_Parameters | |||
Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/ |
||||
Defines a profile of a Parameters resource used to make bulk data export requests. It contains the standard FHIR bulk export parameters including _type, _typeFilter, _outputFormat, and _since for controlling the export scope and format.
This profile addresses the business requirement for structured bulk data export requests to the Health Connect Provider Directory, ensuring consistent parameter usage across different export scenarios.
This section describes the structure and intended use for a HCPD Export Request Parameters resource. This resource is used ONLY within the context of the Bulk Data Extract capability of the HCPD system for submitting export requests. It contains the parameters that control the scope, format, and filtering of bulk data export operations.
The HCPD Export Request Parameters resource is used by Client Requester Actors to specify their bulk data export requirements. This profile ensures consistent parameter usage across different export scenarios including geographical filtering, organization-centric extraction, and healthcare service type-centric extraction.
The HCPD Export Request Parameters resource contains standard FHIR bulk export parameters that control the export operation. This profile enforces proper parameter usage and ensures that type and typeFilter parameters are synchronized.
_type - Comma-separated list of resource types to include (Organization,Location,Practitioner,PractitionerRole,HealthcareService,Endpoint,Provenance)_since - Only resources updated since specified timestamp (ISO 8601 format)_typeFilter - Apply export criteria to specific resource types (e.g., Location?address-state=NSW)_outputFormat - Output format (mandatory, fixed to application/fhir+ndjson)The profile includes invariant hcpd-exp-1 which enforces that the number of _typeFilter parameters SHALL equal the number of resource types specified in the comma-separated _type parameter. This ensures that each resource type has a corresponding filter, maintaining consistent export behavior.
Based on the parameter combinations, the following export scenarios are supported:
| Proximity-based: _typeFilter=Location?near=[LAT] | [LNG] | [DISTANCE] |
| HPI-O identifier: _typeFilter=Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0 | [HPIO] |
| ABN identifier: _typeFilter=Organization?identifier=http://hl7.org.au/id/abn | [ABN] |
| ACN identifier: _typeFilter=Organization?identifier=http://hl7.org.au/id/acn | [ACN] |
| SNOMED-CT service types: _typeFilter=HealthcareService?service-type=[SYSTEM] | [CODE] |
Client Requester Actors SHALL use this profile structure when submitting bulk export requests to ensure consistent parameter formatting and validation. When using _type and _typeFilter parameters, the number of filter parameters MUST equal the number of resource types specified (enforced by invariant hcpd-exp-1).
| Parameter Name | Cardinality | Value Type | Description |
|---|---|---|---|
| _outputFormat | 1..1 | string | Fixed to "application/fhir+ndjson" |
| _type | 1..* | string | Comma-separated resource types: Organization,Location,HealthcareService,Practitioner,PractitionerRole,Endpoint,Provenance |
| _typeFilter | 1..* | string | FHIR search parameters for filtering specific resource types (one entry per _type value) |
| _since | 0..1 | instant | ISO 8601 timestamp - only export resources updated since this date |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters Constraints: hcpd-exp-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for parameter |
C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   parameter:All Slices |
Content/Rules for all slices | |||
   modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
 name |
1..1 | string | Name from the definition | |
 parameter:outputFormat |
C | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) Constraints: inv-1 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
 Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) |
| parameter:type |
C | 1..* | BackboneElement | Resource types to include in export Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type |
| parameter:typeFilter |
C | 1..* | BackboneElement | Export criteria for specific resource types Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type |
 parameter:since |
C | 0..1 | BackboneElement | Only resources updated since specified timestamp Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | instant | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueInstant |
C | 1..1 | instant | If parameter is a data type |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters |
| Slices for parameter |
3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| parameter:outputFormat |
1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) | |
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) | |
| parameter:type |
1..* | BackboneElement | Resource types to include in export | |
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type | |
| parameter:typeFilter |
1..* | BackboneElement | Export criteria for specific resource types | |
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type | |
| parameter:since |
0..1 | BackboneElement | Only resources updated since specified timestamp | |
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |
| Slices for value[x] |
1..1 | instant | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueInstant |
1..1 | instant | If parameter is a data type | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters Constraints: hcpd-exp-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
 meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for parameter |
C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| parameter:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition | |||||
 value[x] |
C | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
 valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
 valueMeta |
Meta | |||||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:outputFormat |
C | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
 Slices for value[x] |
Content/Rules for all slices | |||||||
 value[x]:valueString |
C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
 part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:type |
C | 1..* | BackboneElement | Resource types to include in export Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:typeFilter |
C | 1..* | BackboneElement | Export criteria for specific resource types Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:since |
C | 0..1 | BackboneElement | Only resources updated since specified timestamp Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | instant | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueInstant |
C | 1..1 | instant | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
This structure is derived from Parameters
Summary
Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 13 elements
Fixed: 5 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters Constraints: hcpd-exp-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for parameter |
C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| parameter:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition | |
| parameter:outputFormat |
C | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) |
| parameter:type |
C | 1..* | BackboneElement | Resource types to include in export Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type |
| parameter:typeFilter |
C | 1..* | BackboneElement | Export criteria for specific resource types Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type |
| parameter:since |
C | 0..1 | BackboneElement | Only resources updated since specified timestamp Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |
| Slices for value[x] |
C | 1..1 | instant | If parameter is a data type Slice: Unordered, Closed by type:$this |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueInstant |
C | 1..1 | instant | If parameter is a data type |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
Differential View
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters |
| Slices for parameter |
3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| parameter:outputFormat |
1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) | |
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) | |
| parameter:type |
1..* | BackboneElement | Resource types to include in export | |
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type | |
| parameter:typeFilter |
1..* | BackboneElement | Export criteria for specific resource types | |
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |
| Slices for value[x] |
1..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueString |
1..1 | string | If parameter is a data type | |
| parameter:since |
0..1 | BackboneElement | Only resources updated since specified timestamp | |
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |
| Slices for value[x] |
1..1 | instant | If parameter is a data type Slice: Unordered, Open by type:$this | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueInstant |
1..1 | instant | If parameter is a data type | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters Constraints: hcpd-exp-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| Slices for parameter |
C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| parameter:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition | |||||
| value[x] |
C | 0..1 | If parameter is a data type | |||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:outputFormat |
C | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson) Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _outputFormat (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson (no extensions allowed) | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:type |
C | 1..* | BackboneElement | Resource types to include in export Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _type (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:typeFilter |
C | 1..* | BackboneElement | Export criteria for specific resource types Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _typeFilter (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueString |
C | 1..1 | string | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| parameter:since |
C | 0..1 | BackboneElement | Only resources updated since specified timestamp Constraints: inv-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | |||||
| name |
1..1 | string | Name from the definition Fixed Value: _since (no extensions allowed) | |||||
| Slices for value[x] |
C | 1..1 | instant | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
| Slices for value[x] |
Content/Rules for all slices | |||||||
| value[x]:valueInstant |
C | 1..1 | instant | If parameter is a data type | ||||
| resource |
C | 0..1 | Resource | If parameter is a whole resource | ||||
| part |
0..* | See parameter (Parameters) | Named part of a multi-part parameter | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| hcpd-exp-1 | error | Parameters | Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters |
parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()
|
This structure is derived from Parameters
Summary
Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 13 elements
Fixed: 5 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2026+ Australian Digital Health Agency. Package au.gov.digitalhealth.fhir.hcpd#26.0.0 based on FHIR 4.0.1. Generated 2026-11-03
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
