description: Profile for FHIR Bulk Data $export operation POST parameters. Based on https://build.fhir.org/ig/HL7/bulk-data/export.html
package_name: io.health-samurai.core.r3
derivation: constraint
name: BulkExportProfile
type: Parameters
elements:
  parameter:
    index: 0
    slicing:
      rules: closed
      discriminator:
      - {path: name, type: value}
      min: null
      slices:
        patient:
          match: {name: patient}
          schema:
            short: Specific patients to export. Omit to export all.
            array: true
            index: 26
            elements:
              name:
                pattern: {type: String, value: patient}
                index: 27
              value:
                choices: [valueReference]
                index: 29
              valueReference: {type: Reference, choiceOf: value, index: 30}
        aidboxAzureStorage:
          match: {name: _aidbox.azureStorage}
          schema:
            short: 'Aidbox: override Azure storage account name.'
            index: 66
            elements:
              name:
                pattern: {type: String, value: _aidbox.azureStorage}
                index: 67
              value:
                choices: [valueString]
                index: 69
              valueString: {type: string, choiceOf: value, index: 70}
        _since:
          match: {name: _since}
          schema:
            short: Include resources modified after this timestamp.
            index: 6
            elements:
              name:
                pattern: {type: String, value: _since}
                index: 7
              value:
                choices: [valueInstant]
                index: 9
              valueInstant: {type: instant, choiceOf: value, index: 10}
        aidboxStorageAccount:
          match: {name: _aidbox.storageAccount}
          schema:
            short: 'Aidbox: override cloud account reference (ResourceType/id).'
            index: 61
            elements:
              name:
                pattern: {type: String, value: _aidbox.storageAccount}
                index: 62
              value:
                choices: [valueReference]
                index: 64
              valueReference: {type: Reference, choiceOf: value, index: 65}
        _type:
          match: {name: _type}
          schema:
            short: Comma-delimited FHIR resource types to include in the export.
            array: true
            index: 16
            elements:
              name:
                pattern: {type: String, value: _type}
                index: 17
              value:
                choices: [valueString]
                index: 19
              valueString: {type: string, choiceOf: value, index: 20}
        aidboxStorageBucket:
          match: {name: _aidbox.storageBucket}
          schema:
            short: 'Aidbox: override cloud storage bucket name.'
            index: 56
            elements:
              name:
                pattern: {type: String, value: _aidbox.storageBucket}
                index: 57
              value:
                choices: [valueString]
                index: 59
              valueString: {type: string, choiceOf: value, index: 60}
        _until:
          match: {name: _until}
          schema:
            short: Include resources modified before this timestamp. Defaults to operation start time.
            index: 11
            elements:
              name:
                pattern: {type: String, value: _until}
                index: 12
              value:
                choices: [valueInstant]
                index: 14
              valueInstant: {type: instant, choiceOf: value, index: 15}
        _outputFormat:
          match: {name: _outputFormat}
          schema:
            short: 'Output format for exported files (default: application/fhir+ndjson).'
            index: 1
            elements:
              name:
                pattern: {type: String, value: _outputFormat}
                index: 2
              value:
                choices: [valueString]
                index: 4
              valueString: {type: string, choiceOf: value, index: 5}
        onPatientError:
          match: {name: onPatientError}
          schema:
            short: 'Behavior when patient references are invalid: fail (default, returns 422) or ignore (drop and proceed).'
            index: 31
            elements:
              name:
                pattern: {type: String, value: onPatientError}
                index: 32
              value:
                constraint:
                  on-patient-error-1: {human: 'onPatientError must be one of: fail, ignore', severity: error, expression: '%context.subsetOf(''fail'' | ''ignore'')'}
                choices: [valueCode]
                index: 34
              valueCode:
                type: code
                constraint:
                  on-patient-error-1: {human: 'onPatientError must be one of: fail, ignore', severity: error, expression: '%context.subsetOf(''fail'' | ''ignore'')'}
                choiceOf: value
                index: 35
        aidboxStorageProvider:
          match: {name: _aidbox.storageProvider}
          schema:
            short: 'Aidbox: override storage provider type (gcp, aws, azure).'
            index: 51
            elements:
              name:
                pattern: {type: String, value: _aidbox.storageProvider}
                index: 52
              value:
                constraint:
                  storage-type-1: {human: 'Storage type must be one of: gcp, aws, azure', severity: error, expression: '%context.subsetOf(''gcp'' | ''aws'' | ''azure'')'}
                choices: [valueString]
                index: 54
              valueString:
                type: string
                constraint:
                  storage-type-1: {human: 'Storage type must be one of: gcp, aws, azure', severity: error, expression: '%context.subsetOf(''gcp'' | ''aws'' | ''azure'')'}
                choiceOf: value
                index: 55
        organizationIdentifierSystem:
          match: {name: organizationIdentifierSystem}
          schema:
            short: Organization.identifier.system to use for consent actor matching.
            index: 46
            elements:
              name:
                pattern: {type: String, value: organizationIdentifierSystem}
                index: 47
              value:
                choices: [valueUri]
                index: 49
              valueUri: {type: uri, choiceOf: value, index: 50}
        aidboxAzureContainer:
          match: {name: _aidbox.azureContainer}
          schema:
            short: 'Aidbox: override Azure container name.'
            index: 71
            elements:
              name:
                pattern: {type: String, value: _aidbox.azureContainer}
                index: 72
              value:
                choices: [valueString]
                index: 74
              valueString: {type: string, choiceOf: value, index: 75}
        _typeFilter:
          match: {name: _typeFilter}
          schema:
            short: FHIR REST queries to constrain the exported dataset (ResourceType?params).
            array: true
            index: 21
            elements:
              name:
                pattern: {type: String, value: _typeFilter}
                index: 22
              value:
                choices: [valueString]
                index: 24
              valueString: {type: string, choiceOf: value, index: 25}
        consentProfile:
          match: {name: consentProfile}
          schema:
            short: Consent StructureDefinition URL to filter by meta.profile. Omit to match any Consent.
            index: 41
            elements:
              name:
                pattern: {type: String, value: consentProfile}
                index: 42
              value:
                choices: [valueUri]
                index: 44
              valueUri: {type: uri, choiceOf: value, index: 45}
        consentStrategy:
          match: {name: consentStrategy}
          schema:
            short: 'Consent-based patient filtering strategy: opt-in or opt-out.'
            index: 36
            elements:
              name:
                pattern: {type: String, value: consentStrategy}
                index: 37
              value:
                constraint:
                  consent-strategy-1: {human: 'consentStrategy must be one of: opt-in, opt-out', severity: error, expression: '%context.subsetOf(''opt-in'' | ''opt-out'')'}
                choices: [valueCode]
                index: 39
              valueCode:
                type: code
                constraint:
                  consent-strategy-1: {human: 'consentStrategy must be one of: opt-in, opt-out', severity: error, expression: '%context.subsetOf(''opt-in'' | ''opt-out'')'}
                choiceOf: value
                index: 40
package_version: 0.2605.0
class: profile
kind: resource
url: http://health-samurai.io/fhir/core/StructureDefinition/parameters-bulkExportProfile
base: http://hl7.org/fhir/StructureDefinition/Parameters
version: 0.2605.0