FHIR IG analytics| Package | au.gov.digitalhealth.hcpd |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-hcpd-export-request-parameters.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/AuDigitalHealth/HCPD-Snapshot-26.0.0-SPARKED-Testing-20260708/StructureDefinition-hcpd-export-request-parameters.html |
| URL | http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters |
| Version | 26.0.0 |
| Status | active |
| Date | 2026-07-03T05:13:52+00:00 |
| Name | HCPD_Export_Request_Parameters |
| Title | HCPD Export Request Parameters |
| Realm | au |
| Description | 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. |
| Purpose | 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. |
| Copyright | This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/) |
| Type | Parameters |
| Kind | resource |
| CapabilityStatement | ||
| au.gov.digitalhealth.hcpd#current | health-connect-bulk-export-requester | Health Connect Provider Directory Bulk Export Requester |
| au.gov.digitalhealth.hcpd#current | health-connect-provider-directory-responder | Health Connect Provider Directory Responder |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition hcpd-export-request-parameters
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 | S | 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 | S | 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 | S | 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 | S | 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 | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "hcpd-export-request-parameters",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters",
"version": "26.0.0",
"name": "HCPD_Export_Request_Parameters",
"title": "HCPD Export Request Parameters",
"status": "active",
"experimental": false,
"date": "2026-07-03T05:13:52+00:00",
"publisher": "Australian Digital Health Agency",
"contact": [
{
"name": "Australian Digital Health Agency",
"telecom": [
{
"system": "url",
"value": "https://www.digitalhealth.gov.au/"
},
{
"system": "email",
"value": "help@digitalhealth.gov.au"
}
]
},
{
"name": "Australian Digital Health Agency",
"telecom": [
{
"system": "url",
"value": "https://www.digitalhealth.gov.au",
"use": "work"
},
{
"system": "email",
"value": "mailto:help@digitalhealth.gov.au",
"use": "work"
}
]
}
],
"description": "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.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "AU",
"display": "Australia"
}
]
}
],
"purpose": "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.",
"copyright": "This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Parameters",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Parameters",
"path": "Parameters",
"short": "HCPD Bulk Export Request Parameters",
"definition": "Defines how a Parameters resource is represented for bulk data export requests within the HCPD system.",
"comment": "The parameters that may be used are defined by the OperationDefinition resource.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "hcpd-exp-1",
"severity": "error",
"human": "Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters",
"expression": "parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()",
"source": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.id",
"path": "Parameters.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.meta",
"path": "Parameters.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.implicitRules",
"path": "Parameters.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "Parameters.language",
"path": "Parameters.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages|4.0.1"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|4.0.1"
}
},
{
"id": "Parameters.parameter",
"path": "Parameters.parameter",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "name"
}
],
"description": "Slice based on parameter name for different export control parameters",
"rules": "open"
},
"short": "Export parameters to control bulk data extraction",
"definition": "Parameters that control the scope, format, and filtering of the bulk data export operation.",
"min": 3,
"max": "*",
"base": {
"path": "Parameters.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "inv-1",
"severity": "error",
"human": "A parameter must have one and only one of (value, resource, part)",
"expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter.id",
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter.extension",
"path": "Parameters.parameter.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter.modifierExtension",
"path": "Parameters.parameter.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Parameters.parameter.name",
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter.value[x]",
"path": "Parameters.parameter.value[x]",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "Contributor"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter.resource",
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"comment": "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter.part",
"path": "Parameters.parameter.part",
"short": "Named part of a multi-part parameter",
"definition": "A named part of a multi-part parameter.",
"comment": "Only one level of nested parameters is allowed.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat",
"path": "Parameters.parameter",
"sliceName": "outputFormat",
"short": "Output format (fixed to application/fhir+ndjson)",
"definition": "Specifies the format of exported data files. Fixed to NDJSON format.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "inv-1",
"severity": "error",
"human": "A parameter must have one and only one of (value, resource, part)",
"expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat.id",
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:outputFormat.extension",
"path": "Parameters.parameter.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:outputFormat.modifierExtension",
"path": "Parameters.parameter.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Parameters.parameter:outputFormat.name",
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "_outputFormat",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "closed"
},
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "application/fhir+ndjson",
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat.resource",
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"comment": "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:outputFormat.part",
"path": "Parameters.parameter.part",
"short": "Named part of a multi-part parameter",
"definition": "A named part of a multi-part parameter.",
"comment": "Only one level of nested parameters is allowed.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type",
"path": "Parameters.parameter",
"sliceName": "type",
"short": "Resource types to include in export",
"definition": "Comma-separated list of resource types to include, or individual _type parameters for each resource type.",
"min": 1,
"max": "*",
"base": {
"path": "Parameters.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "inv-1",
"severity": "error",
"human": "A parameter must have one and only one of (value, resource, part)",
"expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type.id",
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:type.extension",
"path": "Parameters.parameter.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:type.modifierExtension",
"path": "Parameters.parameter.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Parameters.parameter:type.name",
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "_type",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "closed"
},
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type.resource",
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"comment": "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:type.part",
"path": "Parameters.parameter.part",
"short": "Named part of a multi-part parameter",
"definition": "A named part of a multi-part parameter.",
"comment": "Only one level of nested parameters is allowed.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter",
"path": "Parameters.parameter",
"sliceName": "typeFilter",
"short": "Export criteria for specific resource types",
"definition": "Apply export criteria to specific resource types using FHIR search parameters. SHALL provide at least one _typeFilter for each resource type specified in _type parameters.",
"min": 1,
"max": "*",
"base": {
"path": "Parameters.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "inv-1",
"severity": "error",
"human": "A parameter must have one and only one of (value, resource, part)",
"expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter.id",
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:typeFilter.extension",
"path": "Parameters.parameter.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:typeFilter.modifierExtension",
"path": "Parameters.parameter.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Parameters.parameter:typeFilter.name",
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "_typeFilter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "closed"
},
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter.resource",
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"comment": "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:typeFilter.part",
"path": "Parameters.parameter.part",
"short": "Named part of a multi-part parameter",
"definition": "A named part of a multi-part parameter.",
"comment": "Only one level of nested parameters is allowed.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since",
"path": "Parameters.parameter",
"sliceName": "since",
"short": "Only resources updated since specified timestamp",
"definition": "Only resources updated since the specified timestamp (ISO 8601 format) will be included in the export.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "inv-1",
"severity": "error",
"human": "A parameter must have one and only one of (value, resource, part)",
"expression": "(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))",
"xpath": "(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))",
"source": "http://hl7.org/fhir/StructureDefinition/Parameters|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since.id",
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:since.extension",
"path": "Parameters.parameter.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Parameters.parameter:since.modifierExtension",
"path": "Parameters.parameter.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Parameters.parameter:since.name",
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"fixedString": "_since",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "closed"
},
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since.value[x]:valueInstant",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueInstant",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 1,
"max": "1",
"base": {
"path": "Parameters.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"mustSupport": true,
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since.resource",
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"comment": "When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.",
"min": 0,
"max": "1",
"base": {
"path": "Parameters.parameter.resource",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
],
"isModifier": false,
"isSummary": true
},
{
"id": "Parameters.parameter:since.part",
"path": "Parameters.parameter.part",
"short": "Named part of a multi-part parameter",
"definition": "A named part of a multi-part parameter.",
"comment": "Only one level of nested parameters is allowed.",
"min": 0,
"max": "*",
"base": {
"path": "Parameters.parameter.part",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter",
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "Parameters",
"path": "Parameters",
"short": "HCPD Bulk Export Request Parameters",
"definition": "Defines how a Parameters resource is represented for bulk data export requests within the HCPD system.",
"constraint": [
{
"key": "hcpd-exp-1",
"severity": "error",
"human": "Number of _typeFilter parameters must equal the total number of resource types specified across all _type parameters",
"expression": "parameter.where(name='_typeFilter').count() = parameter.where(name='_type').valueString.select(split(',')).select($this.trim()).count()",
"source": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0"
}
]
},
{
"id": "Parameters.parameter",
"path": "Parameters.parameter",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "name"
}
],
"description": "Slice based on parameter name for different export control parameters",
"rules": "open"
},
"short": "Export parameters to control bulk data extraction",
"definition": "Parameters that control the scope, format, and filtering of the bulk data export operation.",
"min": 3,
"mustSupport": true
},
{
"id": "Parameters.parameter:outputFormat",
"path": "Parameters.parameter",
"sliceName": "outputFormat",
"short": "Output format (fixed to application/fhir+ndjson)",
"definition": "Specifies the format of exported data files. Fixed to NDJSON format.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Parameters.parameter:outputFormat.name",
"path": "Parameters.parameter.name",
"fixedString": "_outputFormat",
"mustSupport": true
},
{
"id": "Parameters.parameter:outputFormat.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Parameters.parameter:outputFormat.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"fixedString": "application/fhir+ndjson",
"mustSupport": true
},
{
"id": "Parameters.parameter:type",
"path": "Parameters.parameter",
"sliceName": "type",
"short": "Resource types to include in export",
"definition": "Comma-separated list of resource types to include, or individual _type parameters for each resource type.",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"id": "Parameters.parameter:type.name",
"path": "Parameters.parameter.name",
"fixedString": "_type",
"mustSupport": true
},
{
"id": "Parameters.parameter:type.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Parameters.parameter:type.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"id": "Parameters.parameter:typeFilter",
"path": "Parameters.parameter",
"sliceName": "typeFilter",
"short": "Export criteria for specific resource types",
"definition": "Apply export criteria to specific resource types using FHIR search parameters. SHALL provide at least one _typeFilter for each resource type specified in _type parameters.",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"id": "Parameters.parameter:typeFilter.name",
"path": "Parameters.parameter.name",
"fixedString": "_typeFilter",
"mustSupport": true
},
{
"id": "Parameters.parameter:typeFilter.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Parameters.parameter:typeFilter.value[x]:valueString",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueString",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"id": "Parameters.parameter:since",
"path": "Parameters.parameter",
"sliceName": "since",
"short": "Only resources updated since specified timestamp",
"definition": "Only resources updated since the specified timestamp (ISO 8601 format) will be included in the export.",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Parameters.parameter:since.name",
"path": "Parameters.parameter.name",
"fixedString": "_since",
"mustSupport": true
},
{
"id": "Parameters.parameter:since.value[x]",
"path": "Parameters.parameter.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Parameters.parameter:since.value[x]:valueInstant",
"path": "Parameters.parameter.value[x]",
"sliceName": "valueInstant",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mustSupport": true
}
]
}
}