ESMD FHIR Implementation Guide
1.0.0 - esmd

ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Esmd Find Bundle List Notifications

Official URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindBundleListNotifications Version: 1.0.0
Active as of 2024-02-25 Computable Name: EsmdFindBundleListNotifications

The Esmd-FindBundleListNotifications profile in the esMD system is designed for Health Information Handlers (HIHs) who need to send multiple delivery confirmations to esMD. This API enables HIHs to efficiently communicate the successful delivery of healthcare documents to multiple providers at once. Using this profile ensures accurate tracking and timestamping of each delivery, streamlining the documentation process and enhancing the accountability and transparency of document exchanges within the esMD ecosystem. This capability is vital for maintaining precise records of document transactions between HIHs and providers.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 EsmdMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
inv-esmd-meta-security-01: esMD supports only V security code
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: searchset
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entry:FindListTransactionNotification ΣC 0..* BackboneElement Transaction Notification List Entry
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ele-1: All FHIR elements must have a @value or children
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... id SΣ 1..1 id Logical id of this artifact
...... meta SΣ 0..1 EsmdMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
....... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children

Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification
....... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
inv-esmd-meta-security-01: esMD supports only V security code
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
...... contained 1..* Resource Contained, inline Resources
...... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:uniqueId S 1..1 string Unique ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:transactionId S 1..1 string esMD Transaction ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:organizationId S 1..1 string Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:reviewContractorOid S 1..1 code Review Contractor Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ReviewContractorOid
Binding: ESMD ReviewContractorOIDs ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:linesOfBusinessId S 1..1 code Lines of Bunsiness ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-LinesOfBusinessId
Binding: esMD Lines Of Business ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:claimId S 0..1 string Claim ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:caseId S 0..1 string Case ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:requestId S 0..1 string Request ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RequestId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:statusCode S 1..1 code Status Code
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode
Binding: ESMD StatusCodes ValueSet (required): Codes used for esMD Custom Status Codes


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:deliveryDateTime S 0..1 string Review Contractor Delivery Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcPickupDateTime S 0..1 string Review Contractor Pickup Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCPickupDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcCreationDateTime S 0..1 string Review Contractor Notification Creation Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCCreationDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcSubmissionDateTime S 0..1 string Review Contractor Notification Submission Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCSubmissionDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
Required Pattern: current
...... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


ele-1: All FHIR elements must have a @value or children
Required Pattern: working
...... title SΣ 1..1 string Descriptive name for the list
ele-1: All FHIR elements must have a @value or children
Example General: Dr. Jane's Patients
...... subject SΣ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
ele-1: All FHIR elements must have a @value or children
...... date SΣ 1..1 dateTime When the list was prepared
ele-1: All FHIR elements must have a @value or children
...... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
ele-1: All FHIR elements must have a @value or children
...... note 0..1 Annotation Comments about the list
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:FindListTransactionNotificationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:FindListTransactionNotificationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-esmd-meta-security-01errorBundle.meta.security, Bundle.entry:FindListTransactionNotification.resource.meta.securityesMD supports only V security code
: code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... id S 1..1 id Logical id of this artifact
... meta S 0..1 EsmdMeta Metadata about the resource
.... security S 0..* Coding Security Labels applied to this resource
... identifier S 0..1 Identifier Persistent identifier for the bundle
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:FindListTransactionNotification 0..* BackboneElement Transaction Notification List Entry
..... fullUrl S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... meta
....... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 EsmdMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-esmd-meta-security-01: esMD supports only V security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:FindListTransactionNotification ΣC 0..* BackboneElement Transaction Notification List Entry
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... id SΣ 1..1 id Logical id of this artifact
...... meta SΣ 0..1 EsmdMeta Metadata about the resource
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... versionId Σ 0..1 id Version specific identifier
....... lastUpdated Σ 0..1 instant When the resource version last changed
....... source Σ 0..1 uri Identifies where the resource comes from
....... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this

Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification
....... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-esmd-meta-security-01: esMD supports only V security code
....... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
...... contained 1..* Resource Contained, inline Resources
...... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:uniqueId S 1..1 string Unique ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
....... extension:transactionId S 1..1 string esMD Transaction ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
....... extension:organizationId S 1..1 string Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
....... extension:reviewContractorOid S 1..1 code Review Contractor Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ReviewContractorOid
Binding: ESMD ReviewContractorOIDs ValueSet (required)
....... extension:linesOfBusinessId S 1..1 code Lines of Bunsiness ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-LinesOfBusinessId
Binding: esMD Lines Of Business ValueSet (required)
....... extension:claimId S 0..1 string Claim ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
....... extension:caseId S 0..1 string Case ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
....... extension:requestId S 0..1 string Request ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RequestId
....... extension:statusCode S 1..1 code Status Code
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode
Binding: ESMD StatusCodes ValueSet (required): Codes used for esMD Custom Status Codes


....... extension:deliveryDateTime S 0..1 string Review Contractor Delivery Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
....... extension:rcPickupDateTime S 0..1 string Review Contractor Pickup Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCPickupDateTime
....... extension:rcCreationDateTime S 0..1 string Review Contractor Notification Creation Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCCreationDateTime
....... extension:rcSubmissionDateTime S 0..1 string Review Contractor Notification Submission Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCSubmissionDateTime
...... identifier 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
...... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
...... title SΣ 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
...... code Σ 0..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.

...... subject SΣ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
...... date SΣ 1..1 dateTime When the list was prepared
...... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
...... note 0..1 Annotation Comments about the list
...... entry C 0..* BackboneElement Entries in the list
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

....... deleted ?!C 0..1 boolean If this item is actually marked as deleted
....... date 0..1 dateTime When item added to list
....... item 1..1 Reference(Resource) Actual entry
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:FindListTransactionNotification.resource.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:FindListTransactionNotificationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:FindListTransactionNotificationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-esmd-meta-security-01errorBundle.meta.security, Bundle.entry:FindListTransactionNotification.resource.meta.securityesMD supports only V security code
: code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 EsmdMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
inv-esmd-meta-security-01: esMD supports only V security code
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


ele-1: All FHIR elements must have a @value or children
Required Pattern: searchset
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entry:FindListTransactionNotification ΣC 0..* BackboneElement Transaction Notification List Entry
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ele-1: All FHIR elements must have a @value or children
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... id SΣ 1..1 id Logical id of this artifact
...... meta SΣ 0..1 EsmdMeta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
....... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children

Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification
....... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
inv-esmd-meta-security-01: esMD supports only V security code
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
...... contained 1..* Resource Contained, inline Resources
...... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:uniqueId S 1..1 string Unique ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:transactionId S 1..1 string esMD Transaction ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:organizationId S 1..1 string Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:reviewContractorOid S 1..1 code Review Contractor Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ReviewContractorOid
Binding: ESMD ReviewContractorOIDs ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:linesOfBusinessId S 1..1 code Lines of Bunsiness ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-LinesOfBusinessId
Binding: esMD Lines Of Business ValueSet (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:claimId S 0..1 string Claim ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:caseId S 0..1 string Case ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:requestId S 0..1 string Request ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RequestId
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:statusCode S 1..1 code Status Code
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode
Binding: ESMD StatusCodes ValueSet (required): Codes used for esMD Custom Status Codes


ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:deliveryDateTime S 0..1 string Review Contractor Delivery Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcPickupDateTime S 0..1 string Review Contractor Pickup Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCPickupDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcCreationDateTime S 0..1 string Review Contractor Notification Creation Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCCreationDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... extension:rcSubmissionDateTime S 0..1 string Review Contractor Notification Submission Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCSubmissionDateTime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
Required Pattern: current
...... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


ele-1: All FHIR elements must have a @value or children
Required Pattern: working
...... title SΣ 1..1 string Descriptive name for the list
ele-1: All FHIR elements must have a @value or children
Example General: Dr. Jane's Patients
...... subject SΣ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
ele-1: All FHIR elements must have a @value or children
...... date SΣ 1..1 dateTime When the list was prepared
ele-1: All FHIR elements must have a @value or children
...... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
ele-1: All FHIR elements must have a @value or children
...... note 0..1 Annotation Comments about the list
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:FindListTransactionNotificationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:FindListTransactionNotificationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-esmd-meta-security-01errorBundle.meta.security, Bundle.entry:FindListTransactionNotification.resource.meta.securityesMD supports only V security code
: code.exists() implies (code = 'V' or code = 'HTEST')

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... id S 1..1 id Logical id of this artifact
... meta S 0..1 EsmdMeta Metadata about the resource
.... security S 0..* Coding Security Labels applied to this resource
... identifier S 0..1 Identifier Persistent identifier for the bundle
... Slices for entry 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
.... entry:FindListTransactionNotification 0..* BackboneElement Transaction Notification List Entry
..... fullUrl S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... meta
....... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 0..1 EsmdMeta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this
.... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-esmd-meta-security-01: esMD supports only V security code
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 0..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: searchset
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:FindListTransactionNotification ΣC 0..* BackboneElement Transaction Notification List Entry
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource S 1..1 EsmdFindListTransactionNotification A list is a curated collection of resources
...... id SΣ 1..1 id Logical id of this artifact
...... meta SΣ 0..1 EsmdMeta Metadata about the resource
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... versionId Σ 0..1 id Version specific identifier
....... lastUpdated Σ 0..1 instant When the resource version last changed
....... source Σ 0..1 uri Identifies where the resource comes from
....... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Slice: Unordered, Open by value:$this

Required Pattern: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-FindListTransactionNotification
....... security SΣC 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


inv-esmd-meta-security-01: esMD supports only V security code
....... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
...... text 0..1 Narrative Text summary of the resource, for human interpretation
...... contained 1..* Resource Contained, inline Resources
...... Slices for extension 6..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:uniqueId S 1..1 string Unique ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
....... extension:transactionId S 1..1 string esMD Transaction ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
....... extension:organizationId S 1..1 string Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
....... extension:reviewContractorOid S 1..1 code Review Contractor Organization ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ReviewContractorOid
Binding: ESMD ReviewContractorOIDs ValueSet (required)
....... extension:linesOfBusinessId S 1..1 code Lines of Bunsiness ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-LinesOfBusinessId
Binding: esMD Lines Of Business ValueSet (required)
....... extension:claimId S 0..1 string Claim ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
....... extension:caseId S 0..1 string Case ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
....... extension:requestId S 0..1 string Request ID
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RequestId
....... extension:statusCode S 1..1 code Status Code
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-StatusCode
Binding: ESMD StatusCodes ValueSet (required): Codes used for esMD Custom Status Codes


....... extension:deliveryDateTime S 0..1 string Review Contractor Delivery Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
....... extension:rcPickupDateTime S 0..1 string Review Contractor Pickup Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCPickupDateTime
....... extension:rcCreationDateTime S 0..1 string Review Contractor Notification Creation Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCCreationDateTime
....... extension:rcSubmissionDateTime S 0..1 string Review Contractor Notification Submission Date and Time
URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-RCSubmissionDateTime
...... identifier 0..* Identifier Business identifier
...... status ?!SΣ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
...... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.


Required Pattern: working
...... title SΣ 1..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
...... code Σ 0..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.

...... subject SΣ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
...... date SΣ 1..1 dateTime When the list was prepared
...... source SΣ 0..1 Reference(Practitioner | PractitionerRole | Patient | Device) Who and/or what defined the list contents (aka Author)
...... note 0..1 Annotation Comments about the list
...... entry C 0..* BackboneElement Entries in the list
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

....... deleted ?!C 0..1 boolean If this item is actually marked as deleted
....... date 0..1 dateTime When item added to list
....... item 1..1 Reference(Resource) Actual entry
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.

...... score Σ 0..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache currency
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.typerequiredPattern: searchset
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Bundle.entry:FindListTransactionNotification.resource.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.moderequiredPattern: working
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.codeexampleExampleUseCodesForList
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.resource.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
from the FHIR Standard
Bundle.entry:FindListTransactionNotification.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:FindListTransactionNotificationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:FindListTransactionNotificationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-esmd-meta-security-01errorBundle.meta.security, Bundle.entry:FindListTransactionNotification.resource.meta.securityesMD supports only V security code
: code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

Summary

Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron