FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageio.health-samurai.core.r4b
Resource TypeStructureDefinition
IdStructureDefinition-parameters-bulkExportProfile.json
FHIR VersionR4B
Sourcehttps://simplifier.net/resolve?scope=io.health-samurai.core.r4b@0.2606.2&canonical=http://health-samurai.io/fhir/core/StructureDefinition/parameters-bulkExportProfile
URLhttp://health-samurai.io/fhir/core/StructureDefinition/parameters-bulkExportProfile
Version0.2606.2
Statusactive
NameBulkExportProfile
TitleBulk Export Profile
Realmuv
DescriptionProfile for FHIR Bulk Data $export operation POST parameters. Based on https://build.fhir.org/ig/HL7/bulk-data/export.html
TypeParameters
Kindresource

Resources that use this resource

No resources found


Resources that this resource uses

ValueSet
io.health-samurai.core.r4b#0.2606.2consent-strategyConsent Strategy
io.health-samurai.core.r4b#0.2606.2export-storage-typeExport Storage Type
io.health-samurai.core.r4b#0.2606.2on-patient-errorOn Patient Error

Narrative

No narrative content found in resource


Source1

{
  "description": "Profile for FHIR Bulk Data $export operation POST parameters. Based on https://build.fhir.org/ig/HL7/bulk-data/export.html",
  "derivation": "constraint",
  "publisher": "Health Samurai",
  "fhirVersion": "4.3.0",
  "name": "BulkExportProfile",
  "abstract": false,
  "type": "Parameters",
  "resourceType": "StructureDefinition",
  "title": "Bulk Export Profile",
  "status": "active",
  "id": "parameters-bulkExportProfile",
  "kind": "resource",
  "url": "http://health-samurai.io/fhir/core/StructureDefinition/parameters-bulkExportProfile",
  "version": "0.2606.2",
  "differential": {
    "element": [
      {
        "id": "Parameters",
        "path": "Parameters",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Parameters.parameter",
        "path": "Parameters.parameter",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "name"
            }
          ],
          "rules": "closed"
        }
      },
      {
        "id": "Parameters.parameter:_outputFormat",
        "path": "Parameters.parameter",
        "sliceName": "_outputFormat",
        "short": "Output format for exported files (default: application/fhir+ndjson).",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:_outputFormat.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_outputFormat"
      },
      {
        "id": "Parameters.parameter:_outputFormat.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:_since",
        "path": "Parameters.parameter",
        "sliceName": "_since",
        "short": "Include resources modified after this timestamp.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:_since.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_since"
      },
      {
        "id": "Parameters.parameter:_since.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "id": "Parameters.parameter:_until",
        "path": "Parameters.parameter",
        "sliceName": "_until",
        "short": "Include resources modified before this timestamp. Defaults to operation start time.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:_until.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_until"
      },
      {
        "id": "Parameters.parameter:_until.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "id": "Parameters.parameter:_type",
        "path": "Parameters.parameter",
        "sliceName": "_type",
        "short": "Comma-delimited FHIR resource types to include in the export.",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Parameters.parameter:_type.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_type"
      },
      {
        "id": "Parameters.parameter:_type.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:_typeFilter",
        "path": "Parameters.parameter",
        "sliceName": "_typeFilter",
        "short": "FHIR REST queries to constrain the exported dataset (ResourceType?params).",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Parameters.parameter:_typeFilter.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_typeFilter"
      },
      {
        "id": "Parameters.parameter:_typeFilter.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:_elements",
        "path": "Parameters.parameter",
        "sliceName": "_elements",
        "short": "Root element names to include in exported resources (experimental). Each entry is a comma-separated list of element names or a single element name.",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Parameters.parameter:_elements.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_elements"
      },
      {
        "id": "Parameters.parameter:_elements.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:patient",
        "path": "Parameters.parameter",
        "sliceName": "patient",
        "short": "Specific patients to export. Omit to export all.",
        "min": 0,
        "max": "*"
      },
      {
        "id": "Parameters.parameter:patient.name",
        "path": "Parameters.parameter.name",
        "fixedString": "patient"
      },
      {
        "id": "Parameters.parameter:patient.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "Parameters.parameter:onPatientError",
        "path": "Parameters.parameter",
        "sliceName": "onPatientError",
        "short": "Behavior when patient references are invalid: fail (default, returns 422) or ignore (drop and proceed).",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:onPatientError.name",
        "path": "Parameters.parameter.name",
        "fixedString": "onPatientError"
      },
      {
        "id": "Parameters.parameter:onPatientError.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://health-samurai.io/fhir/core/ValueSet/on-patient-error"
        },
        "constraint": [
          {
            "key": "on-patient-error-1",
            "severity": "error",
            "human": "onPatientError must be one of: fail, ignore",
            "expression": "%context.subsetOf('fail' | 'ignore')"
          }
        ]
      },
      {
        "id": "Parameters.parameter:consentStrategy",
        "path": "Parameters.parameter",
        "sliceName": "consentStrategy",
        "short": "Consent-based patient filtering strategy: opt-in or opt-out.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:consentStrategy.name",
        "path": "Parameters.parameter.name",
        "fixedString": "consentStrategy"
      },
      {
        "id": "Parameters.parameter:consentStrategy.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://health-samurai.io/fhir/core/ValueSet/consent-strategy"
        },
        "constraint": [
          {
            "key": "consent-strategy-1",
            "severity": "error",
            "human": "consentStrategy must be one of: opt-in, opt-out",
            "expression": "%context.subsetOf('opt-in' | 'opt-out')"
          }
        ]
      },
      {
        "id": "Parameters.parameter:consentProfile",
        "path": "Parameters.parameter",
        "sliceName": "consentProfile",
        "short": "Consent StructureDefinition URL to filter by meta.profile. Omit to match any Consent.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:consentProfile.name",
        "path": "Parameters.parameter.name",
        "fixedString": "consentProfile"
      },
      {
        "id": "Parameters.parameter:consentProfile.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "Parameters.parameter:organizationIdentifierSystem",
        "path": "Parameters.parameter",
        "sliceName": "organizationIdentifierSystem",
        "short": "Organization.identifier.system to use for consent actor matching.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:organizationIdentifierSystem.name",
        "path": "Parameters.parameter.name",
        "fixedString": "organizationIdentifierSystem"
      },
      {
        "id": "Parameters.parameter:organizationIdentifierSystem.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "id": "Parameters.parameter:aidboxStorageProvider",
        "path": "Parameters.parameter",
        "sliceName": "aidboxStorageProvider",
        "short": "Aidbox: override storage provider type (gcp, aws, azure).",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:aidboxStorageProvider.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_aidbox.storageProvider"
      },
      {
        "id": "Parameters.parameter:aidboxStorageProvider.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ],
        "binding": {
          "strength": "extensible",
          "valueSet": "http://health-samurai.io/fhir/core/ValueSet/export-storage-type"
        },
        "constraint": [
          {
            "key": "storage-type-1",
            "severity": "error",
            "human": "Storage type must be one of: gcp, aws, azure",
            "expression": "%context.subsetOf('gcp' | 'aws' | 'azure')"
          }
        ]
      },
      {
        "id": "Parameters.parameter:aidboxStorageBucket",
        "path": "Parameters.parameter",
        "sliceName": "aidboxStorageBucket",
        "short": "Aidbox: override cloud storage bucket name.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:aidboxStorageBucket.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_aidbox.storageBucket"
      },
      {
        "id": "Parameters.parameter:aidboxStorageBucket.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:aidboxStorageAccount",
        "path": "Parameters.parameter",
        "sliceName": "aidboxStorageAccount",
        "short": "Aidbox: override cloud account reference (ResourceType/id).",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:aidboxStorageAccount.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_aidbox.storageAccount"
      },
      {
        "id": "Parameters.parameter:aidboxStorageAccount.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "Parameters.parameter:aidboxAzureStorage",
        "path": "Parameters.parameter",
        "sliceName": "aidboxAzureStorage",
        "short": "Aidbox: override Azure storage account name.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:aidboxAzureStorage.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_aidbox.azureStorage"
      },
      {
        "id": "Parameters.parameter:aidboxAzureStorage.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:aidboxAzureContainer",
        "path": "Parameters.parameter",
        "sliceName": "aidboxAzureContainer",
        "short": "Aidbox: override Azure container name.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Parameters.parameter:aidboxAzureContainer.name",
        "path": "Parameters.parameter.name",
        "fixedString": "_aidbox.azureContainer"
      },
      {
        "id": "Parameters.parameter:aidboxAzureContainer.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters"
}