# Health Connect Australia Provider Directory FHIR Implementation Guide

26.0.0 - Trial

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

## Resource Profile: HCPD Export Request Parameters

Official URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters | Version: 26.0.0
Active as of 2026-06-17 | Computable Name: HCPD_Export_Request_Parameters
Usage:Jurisdiction: Australia
Copyright/Legal: Copyright © 2026 Australian Digital Health Agency - All rights reserved. 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.

## Scope

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 Requestor 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.

## Usage notes

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.

### Standard FHIR Bulk Export parameters

- `_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)

### Parameter synchronization

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.

### Supported export scenarios

Based on the parameter combinations, the following export scenarios are supported:

#### Geographical filtering

- State-based: _typeFilter=Location?address-state=[STATE]
- Postcode-based: _typeFilter=Location?address-postalcode=[POSTCODE]

- Proximity-based: _typeFilter=Location?near=[LAT] | [LNG] | [DISTANCE]

- City/suburb: _typeFilter=Location?address-city=[CITY]

#### Organization-centric extraction

- 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]

- Organization name: _typeFilter=Organization?name=[NAME]

#### Healthcare service type-centric extraction

- SNOMED-CT service types: _typeFilter=HealthcareService?service-type=[SYSTEM] | [CODE]

### Implementation requirements

Client Requestor 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 reference

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:

- Examples for this Profile: Parameters/example-hcpd-export-request-parameters-1 and Parameters/example-hcpd-export-request-parameters-2
- CapabilityStatements using this Profile: Health Connect Provider Directory Bulk Export Requester and Health Connect Provider Directory Responder

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | S Σ C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S Σ C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _type
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _since
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 | S Σ C | 1..1 | instant | If parameter is a data type
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | Parameters.implicitRules, Parameters.parameter, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter:outputFormat, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:outputFormat.name, Parameters.parameter:outputFormat.value[x], Parameters.parameter:outputFormat.value[x]:valueString, Parameters.parameter:type, Parameters.parameter:type.modifierExtension, Parameters.parameter:type.name, Parameters.parameter:type.value[x], Parameters.parameter:type.value[x]:valueString, Parameters.parameter:typeFilter, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:typeFilter.name, Parameters.parameter:typeFilter.value[x], Parameters.parameter:typeFilter.value[x]:valueString, Parameters.parameter:since, Parameters.parameter:since.modifierExtension, Parameters.parameter:since.name, Parameters.parameter:since.value[x], Parameters.parameter:since.value[x]:valueInstant | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Parameters.parameter.modifierExtension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:type.modifierExtension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:since.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
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()`
inv-1 | error | Parameters.parameter, Parameters.parameter:outputFormat, Parameters.parameter:type, Parameters.parameter:typeFilter, Parameters.parameter:since | A parameter must have one and only one of (value, resource, part) | `(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))`

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters
Slices for parameter | S | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name
parameter:outputFormat |  | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson)
name | S | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
parameter:type |  | 1..* | BackboneElement | Resource types to include in export
name | S | 1..1 | string | Name from the definition Fixed Value: _type
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 | S | 1..1 | string | If parameter is a data type
parameter:typeFilter |  | 1..* | BackboneElement | Export criteria for specific resource types
name | S | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S | 1..1 | string | If parameter is a data type
parameter:since |  | 0..1 | BackboneElement | Only resources updated since specified timestamp
name | S | 1..1 | string | Name from the definition Fixed Value: _since
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 | S | 1..1 | instant | If parameter is a data type
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | S Σ C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S Σ C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _type
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _since
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 | S Σ 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | Parameters.meta, Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter.value[x], Parameters.parameter.part, Parameters.parameter:outputFormat, Parameters.parameter:outputFormat.extension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:outputFormat.name, Parameters.parameter:outputFormat.value[x], Parameters.parameter:outputFormat.value[x]:valueString, Parameters.parameter:outputFormat.part, Parameters.parameter:type, Parameters.parameter:type.extension, Parameters.parameter:type.modifierExtension, Parameters.parameter:type.name, Parameters.parameter:type.value[x], Parameters.parameter:type.value[x]:valueString, Parameters.parameter:type.part, Parameters.parameter:typeFilter, Parameters.parameter:typeFilter.extension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:typeFilter.name, Parameters.parameter:typeFilter.value[x], Parameters.parameter:typeFilter.value[x]:valueString, Parameters.parameter:typeFilter.part, Parameters.parameter:since, Parameters.parameter:since.extension, Parameters.parameter:since.modifierExtension, Parameters.parameter:since.name, Parameters.parameter:since.value[x], Parameters.parameter:since.value[x]:valueInstant, Parameters.parameter:since.part | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter:outputFormat.extension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:type.extension, Parameters.parameter:type.modifierExtension, Parameters.parameter:typeFilter.extension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:since.extension, Parameters.parameter:since.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
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()`
inv-1 | error | Parameters.parameter, Parameters.parameter:outputFormat, Parameters.parameter:type, Parameters.parameter:typeFilter, Parameters.parameter:since | A parameter must have one and only one of (value, resource, part) | `(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))`

This structure is derived from Parameters

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 9 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.value[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 | S Σ C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S Σ C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _type
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _since
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 | S Σ C | 1..1 | instant | If parameter is a data type
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | Parameters.implicitRules, Parameters.parameter, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter:outputFormat, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:outputFormat.name, Parameters.parameter:outputFormat.value[x], Parameters.parameter:outputFormat.value[x]:valueString, Parameters.parameter:type, Parameters.parameter:type.modifierExtension, Parameters.parameter:type.name, Parameters.parameter:type.value[x], Parameters.parameter:type.value[x]:valueString, Parameters.parameter:typeFilter, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:typeFilter.name, Parameters.parameter:typeFilter.value[x], Parameters.parameter:typeFilter.value[x]:valueString, Parameters.parameter:since, Parameters.parameter:since.modifierExtension, Parameters.parameter:since.name, Parameters.parameter:since.value[x], Parameters.parameter:since.value[x]:valueInstant | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Parameters.parameter.modifierExtension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:type.modifierExtension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:since.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
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()`
inv-1 | error | Parameters.parameter, Parameters.parameter:outputFormat, Parameters.parameter:type, Parameters.parameter:typeFilter, Parameters.parameter:since | A parameter must have one and only one of (value, resource, part) | `(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))`

Differential View

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters(4.0.1) | HCPD Bulk Export Request Parameters
Slices for parameter | S | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name
parameter:outputFormat |  | 1..1 | BackboneElement | Output format (fixed to application/fhir+ndjson)
name | S | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
parameter:type |  | 1..* | BackboneElement | Resource types to include in export
name | S | 1..1 | string | Name from the definition Fixed Value: _type
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 | S | 1..1 | string | If parameter is a data type
parameter:typeFilter |  | 1..* | BackboneElement | Export criteria for specific resource types
name | S | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S | 1..1 | string | If parameter is a data type
parameter:since |  | 0..1 | BackboneElement | Only resources updated since specified timestamp
name | S | 1..1 | string | Name from the definition Fixed Value: _since
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 | S | 1..1 | instant | If parameter is a data type
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | S Σ C | 3..* | BackboneElement | Export parameters to control bulk data extraction Slice: Unordered, Open by value:name Constraints: inv-1
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _outputFormat
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 | S Σ C | 1..1 | string | If parameter is a data type Fixed Value: application/fhir+ndjson
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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _type
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _typeFilter
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 | S Σ 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 | S Σ | 1..1 | string | Name from the definition Fixed Value: _since
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 | S Σ 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

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | Parameters.meta, Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter.value[x], Parameters.parameter.part, Parameters.parameter:outputFormat, Parameters.parameter:outputFormat.extension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:outputFormat.name, Parameters.parameter:outputFormat.value[x], Parameters.parameter:outputFormat.value[x]:valueString, Parameters.parameter:outputFormat.part, Parameters.parameter:type, Parameters.parameter:type.extension, Parameters.parameter:type.modifierExtension, Parameters.parameter:type.name, Parameters.parameter:type.value[x], Parameters.parameter:type.value[x]:valueString, Parameters.parameter:type.part, Parameters.parameter:typeFilter, Parameters.parameter:typeFilter.extension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:typeFilter.name, Parameters.parameter:typeFilter.value[x], Parameters.parameter:typeFilter.value[x]:valueString, Parameters.parameter:typeFilter.part, Parameters.parameter:since, Parameters.parameter:since.extension, Parameters.parameter:since.modifierExtension, Parameters.parameter:since.name, Parameters.parameter:since.value[x], Parameters.parameter:since.value[x]:valueInstant, Parameters.parameter:since.part | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter:outputFormat.extension, Parameters.parameter:outputFormat.modifierExtension, Parameters.parameter:type.extension, Parameters.parameter:type.modifierExtension, Parameters.parameter:typeFilter.extension, Parameters.parameter:typeFilter.modifierExtension, Parameters.parameter:since.extension, Parameters.parameter:since.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
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()`
inv-1 | error | Parameters.parameter, Parameters.parameter:outputFormat, Parameters.parameter:type, Parameters.parameter:typeFilter, Parameters.parameter:since | A parameter must have one and only one of (value, resource, part) | `(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))`

This structure is derived from Parameters

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 9 elements
Fixed: 5 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.value[x]

Other representations of profile: CSV, Excel, Schematron