FHIR IG analytics| Package | hl7.fhir.uv.bulkdata |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-BulkPublishManifest.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/bulk-data/StructureDefinition-BulkPublishManifest.html |
| URL | http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest |
| Version | 4.0.0-ballot |
| Status | active |
| Date | 2026-07-09T23:05:01+00:00 |
| Name | BulkPublishManifest |
| Title | Bulk Publish Manifest |
| Realm | uv |
| Authority | hl7 |
| Description | Logical model describing the manifest returned by a $bulk-publish endpoint. Extends BulkDataManifest with fields to advertise a Data Provider's update cadence and support pending-based incremental update chains. |
| Type | http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest |
| Kind | logical |
No resources found
| StructureDefinition | ||
| hl7.fhir.uv.bulkdata#current | BulkDataManifest | Bulk Data Manifest |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition BulkPublishManifest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BulkPublishManifest | 0..* | BulkDataManifest | Bulk Publish Manifest Elements defined in Ancestors:@id, extension, manifestType, transactionTime, requiresAccessToken, outputFormat, outputOrganizedBy, outputOrganizedByDetail, output, deleted, outcome, link | |
 manifestType | 0..1 | canonical() | Logical model that defines this publish manifest | |
| transactionTime | 1..1 | instant | Timestamp for the data included in this manifest | |
| requiresAccessToken | 1..1 | boolean | Token required to retrieve published files | |
| outputFormat | 0..1 | string | MIME type of the referenced published files | |
| output | ||||
  url | 1..1 | url | File URL | |
| link | 0..1 | BackboneElement | Next manifest page or update-chain marker | |
| url | 1..1 | url | Next manifest page or marker URL | |
 updateCadence | 0..1 | string | Update Cadence | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "BulkPublishManifest",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.74.42.2"
}
],
"version": "4.0.0-ballot",
"name": "BulkPublishManifest",
"title": "Bulk Publish Manifest",
"status": "active",
"date": "2026-07-09T23:05:01+00:00",
"publisher": "HL7 International / FHIR Infrastructure",
"contact": [
{
"name": "HL7 International / FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
},
{
"system": "email",
"value": "fhir@lists.HL7.org"
}
]
}
],
"description": "Logical model describing the manifest returned by a $bulk-publish endpoint. Extends BulkDataManifest with fields to advertise a Data Provider's update cadence and support pending-based incremental update chains.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest",
"baseDefinition": "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.0-ballot"
}
],
"element": [
{
"id": "BulkPublishManifest",
"path": "BulkPublishManifest",
"short": "Bulk Publish Manifest",
"definition": "Logical model describing the manifest returned by a $bulk-publish endpoint. Extends BulkDataManifest with fields to advertise a Data Provider's update cadence and support pending-based incremental update chains.",
"min": 0,
"max": "*",
"base": {
"path": "Element",
"min": 0,
"max": "*"
},
"condition": [
"ele-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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.id",
"path": "BulkPublishManifest.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": "BulkPublishManifest.extension",
"path": "BulkPublishManifest.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.manifestType",
"path": "BulkPublishManifest.manifestType",
"short": "Logical model that defines this publish manifest",
"definition": "Canonical URL of the logical model that defines the structure of this publish manifest. E.g., `http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest`. This element will be mandatory in a future release of this IG.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.manifestType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical"
}
]
},
{
"id": "BulkPublishManifest.transactionTime",
"path": "BulkPublishManifest.transactionTime",
"short": "Timestamp for the data included in this manifest",
"definition": "Indicates the Data Provider's time when the files in this published manifest were generated. The published files referenced in this manifest SHOULD NOT include any resources modified after this instant, and SHALL include any matching resources modified up to and including this instant.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.transactionTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "instant"
}
]
},
{
"id": "BulkPublishManifest.requiresAccessToken",
"path": "BulkPublishManifest.requiresAccessToken",
"short": "Token required to retrieve published files",
"definition": "Indicates whether downloading the files referenced in this manifest requires the same authorization mechanism as access to the manifest itself. Value SHALL be true when both the manifest endpoint and published file endpoints control access using OAuth 2.0 bearer tokens. Value MAY be false when files are exposed through other access-control schemes such as capability URLs or verifiable file servers within an organization's firewall.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.requiresAccessToken",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "BulkPublishManifest.outputFormat",
"path": "BulkPublishManifest.outputFormat",
"short": "MIME type of the referenced published files",
"definition": "MIME type of the published files referenced in this manifest. Defaults to application/fhir+ndjson when omitted. Describes the expected format of the published files.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.outputFormat",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BulkPublishManifest.outputOrganizedBy",
"path": "BulkPublishManifest.outputOrganizedBy",
"short": "Resource type used to organize output files",
"definition": "When resources in the output files are organized by instances of a resource type, that resource type is specified here. When each output file contains a single resource type, this element SHALL be omitted and an individual type element SHALL be included for each file in the output array.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.outputOrganizedBy",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BulkPublishManifest.outputOrganizedByDetail",
"path": "BulkPublishManifest.outputOrganizedByDetail",
"short": "Output Organized By Detail",
"definition": "Narrative text providing detail on the organizing resource listed in outputOrganizedBy. SHALL NOT be populated in the absence of the outputOrganizedBy element.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.outputOrganizedByDetail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BulkPublishManifest.output",
"path": "BulkPublishManifest.output",
"short": "Output Files",
"definition": "An array of file items with one entry for each generated file.",
"min": 0,
"max": "*",
"base": {
"path": "BulkDataManifest.output",
"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"
}
]
},
{
"id": "BulkPublishManifest.output.id",
"path": "BulkPublishManifest.output.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": "BulkPublishManifest.output.extension",
"path": "BulkPublishManifest.output.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.output.modifierExtension",
"path": "BulkPublishManifest.output.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"
},
{
"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"
}
],
"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": "BulkPublishManifest.output.type",
"path": "BulkPublishManifest.output.type",
"short": "FHIR Resource Type",
"definition": "The FHIR resource type contained in the file. When the manifest does not include an outputOrganizedBy value, this element SHALL be populated. When the manifest includes the outputOrganizedBy element, this element SHALL NOT be populated.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.output.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BulkPublishManifest.output.url",
"path": "BulkPublishManifest.output.url",
"short": "File URL",
"definition": "The absolute path to the file. The format of the file SHOULD match the outputFormat element in this manifest when that element is populated.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.output.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "BulkPublishManifest.output.continuesInFile",
"path": "BulkPublishManifest.output.continuesInFile",
"short": "Continuation File URL",
"definition": "URL of the next output file when resources for an organizing resource span multiple files.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.output.continuesInFile",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "BulkPublishManifest.output.count",
"path": "BulkPublishManifest.output.count",
"short": "Resource Count",
"definition": "The number of resources in the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.output.count",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.output.fileSize",
"path": "BulkPublishManifest.output.fileSize",
"short": "File Size",
"definition": "The size of the file in bytes. This provides Data Consumers with information about the storage and processing requirements for downloading and parsing the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.output.fileSize",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.deleted",
"path": "BulkPublishManifest.deleted",
"short": "Deleted Resource Files",
"definition": "References to files containing pointers to deleted resources in the form of FHIR Transaction Bundles. Each line in the output files SHALL contain a FHIR Bundle with a type of transaction which SHALL contain one or more entry items that reflect a deleted resource. In each entry, the request.url and request.method elements SHALL be populated and request.method SHALL be set to DELETE.",
"min": 0,
"max": "*",
"base": {
"path": "BulkDataManifest.deleted",
"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"
}
]
},
{
"id": "BulkPublishManifest.deleted.id",
"path": "BulkPublishManifest.deleted.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": "BulkPublishManifest.deleted.extension",
"path": "BulkPublishManifest.deleted.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.deleted.modifierExtension",
"path": "BulkPublishManifest.deleted.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"
},
{
"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"
}
],
"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": "BulkPublishManifest.deleted.url",
"path": "BulkPublishManifest.deleted.url",
"short": "File URL",
"definition": "The absolute path to the file.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.deleted.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "BulkPublishManifest.deleted.count",
"path": "BulkPublishManifest.deleted.count",
"short": "Resource Count",
"definition": "The number of resources in the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.deleted.count",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.deleted.fileSize",
"path": "BulkPublishManifest.deleted.fileSize",
"short": "File Size",
"definition": "The size of the file in bytes. This provides Data Consumers with information about the storage and processing requirements for downloading and parsing the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.deleted.fileSize",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.outcome",
"path": "BulkPublishManifest.outcome",
"short": "Outcome Files",
"definition": "Files containing OperationOutcome resources. Error, success, warning, information and other messages related to the operation SHOULD be included here (not in output).",
"min": 0,
"max": "*",
"base": {
"path": "BulkDataManifest.outcome",
"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"
}
]
},
{
"id": "BulkPublishManifest.outcome.id",
"path": "BulkPublishManifest.outcome.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": "BulkPublishManifest.outcome.extension",
"path": "BulkPublishManifest.outcome.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.outcome.modifierExtension",
"path": "BulkPublishManifest.outcome.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"
},
{
"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"
}
],
"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": "BulkPublishManifest.outcome.url",
"path": "BulkPublishManifest.outcome.url",
"short": "File URL",
"definition": "The absolute path to the file.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.outcome.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "BulkPublishManifest.outcome.count",
"path": "BulkPublishManifest.outcome.count",
"short": "Resource Count",
"definition": "The number of resources in the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.outcome.count",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.outcome.fileSize",
"path": "BulkPublishManifest.outcome.fileSize",
"short": "File Size",
"definition": "The size of the file in bytes. This provides Data Consumers with information about the storage and processing requirements for downloading and parsing the file.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.outcome.fileSize",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.outcome.countSeverity",
"path": "BulkPublishManifest.outcome.countSeverity",
"short": "Count by severity",
"definition": "Count of OperationOutcome resources grouped by severity level.",
"min": 0,
"max": "*",
"base": {
"path": "BulkDataManifest.outcome.countSeverity",
"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"
}
]
},
{
"id": "BulkPublishManifest.outcome.countSeverity.id",
"path": "BulkPublishManifest.outcome.countSeverity.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": "BulkPublishManifest.outcome.countSeverity.extension",
"path": "BulkPublishManifest.outcome.countSeverity.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.outcome.countSeverity.modifierExtension",
"path": "BulkPublishManifest.outcome.countSeverity.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"
},
{
"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"
}
],
"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": "BulkPublishManifest.outcome.countSeverity.code",
"path": "BulkPublishManifest.outcome.countSeverity.code",
"short": "Severity",
"definition": "Severity level from OperationOutcome.issue.severity (fatal, error, warning, information, success)",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.outcome.countSeverity.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/issue-severity"
}
},
{
"id": "BulkPublishManifest.outcome.countSeverity.count",
"path": "BulkPublishManifest.outcome.countSeverity.count",
"short": "Count",
"definition": "The number of OperationOutcome resources in the file with this severity level.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.outcome.countSeverity.count",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "BulkPublishManifest.link",
"path": "BulkPublishManifest.link",
"short": "Next manifest page or update-chain marker",
"definition": "When present, a single link with relation `next` points to another manifest page, an incremental update manifest page, or a pending or closed update-chain marker.",
"min": 0,
"max": "1",
"base": {
"path": "BulkDataManifest.link",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "bdm-link-relation-next",
"severity": "error",
"human": "Manifest links SHALL use a relation value of 'next'.",
"expression": "relation = 'next'",
"source": "http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkDataManifest"
},
{
"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"
}
]
},
{
"id": "BulkPublishManifest.link.id",
"path": "BulkPublishManifest.link.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": "BulkPublishManifest.link.extension",
"path": "BulkPublishManifest.link.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"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"
},
{
"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"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BulkPublishManifest.link.modifierExtension",
"path": "BulkPublishManifest.link.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"
},
{
"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"
}
],
"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": "BulkPublishManifest.link.relation",
"path": "BulkPublishManifest.link.relation",
"short": "Relation",
"definition": "The relationship type. Value SHALL be 'next', indicating the URL points to the location of another manifest.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.link.relation",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "BulkPublishManifest.link.url",
"path": "BulkPublishManifest.link.url",
"short": "Next manifest page or marker URL",
"definition": "URL pointing to another manifest page, or to an operation-defined marker such as `#pending` or `#closed`.",
"min": 1,
"max": "1",
"base": {
"path": "BulkDataManifest.link.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
]
},
{
"id": "BulkPublishManifest.updateCadence",
"path": "BulkPublishManifest.updateCadence",
"short": "Update Cadence",
"definition": "ISO 8601 duration indicating the typical rate at which the Data Provider expects the manifest or pending update-chain pages to change. When provided, Data Consumers SHOULD use this value to choose a polling interval for subsequent requests.",
"min": 0,
"max": "1",
"base": {
"path": "BulkPublishManifest.updateCadence",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "BulkPublishManifest",
"path": "BulkPublishManifest",
"short": "Bulk Publish Manifest",
"definition": "Logical model describing the manifest returned by a $bulk-publish endpoint. Extends BulkDataManifest with fields to advertise a Data Provider's update cadence and support pending-based incremental update chains."
},
{
"id": "BulkPublishManifest.manifestType",
"path": "BulkPublishManifest.manifestType",
"short": "Logical model that defines this publish manifest",
"definition": "Canonical URL of the logical model that defines the structure of this publish manifest. E.g., `http://hl7.org/fhir/uv/bulkdata/StructureDefinition/BulkPublishManifest`. This element will be mandatory in a future release of this IG."
},
{
"id": "BulkPublishManifest.transactionTime",
"path": "BulkPublishManifest.transactionTime",
"definition": "Indicates the Data Provider's time when the files in this published manifest were generated. The published files referenced in this manifest SHOULD NOT include any resources modified after this instant, and SHALL include any matching resources modified up to and including this instant."
},
{
"id": "BulkPublishManifest.requiresAccessToken",
"path": "BulkPublishManifest.requiresAccessToken",
"short": "Token required to retrieve published files",
"definition": "Indicates whether downloading the files referenced in this manifest requires the same authorization mechanism as access to the manifest itself. Value SHALL be true when both the manifest endpoint and published file endpoints control access using OAuth 2.0 bearer tokens. Value MAY be false when files are exposed through other access-control schemes such as capability URLs or verifiable file servers within an organization's firewall."
},
{
"id": "BulkPublishManifest.outputFormat",
"path": "BulkPublishManifest.outputFormat",
"short": "MIME type of the referenced published files",
"definition": "MIME type of the published files referenced in this manifest. Defaults to application/fhir+ndjson when omitted. Describes the expected format of the published files."
},
{
"id": "BulkPublishManifest.output.url",
"path": "BulkPublishManifest.output.url",
"definition": "The absolute path to the file. The format of the file SHOULD match the outputFormat element in this manifest when that element is populated."
},
{
"id": "BulkPublishManifest.link",
"path": "BulkPublishManifest.link",
"short": "Next manifest page or update-chain marker",
"definition": "When present, a single link with relation `next` points to another manifest page, an incremental update manifest page, or a pending or closed update-chain marker.",
"max": "1"
},
{
"id": "BulkPublishManifest.link.url",
"path": "BulkPublishManifest.link.url",
"short": "Next manifest page or marker URL",
"definition": "URL pointing to another manifest page, or to an operation-defined marker such as `#pending` or `#closed`."
},
{
"id": "BulkPublishManifest.updateCadence",
"path": "BulkPublishManifest.updateCadence",
"short": "Update Cadence",
"definition": "ISO 8601 duration indicating the typical rate at which the Data Provider expects the manifest or pending update-chain pages to change. When provided, Data Consumers SHOULD use this value to choose a polling interval for subsequent requests.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}