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

• Content
• Detailed Descriptions
• Mappings
• Examples
• JSON

Resource Profile: Esmd Bundle Service Registration Profile

The Esmd-BundleServiceRegistration profile extends the HL7 Bundle resource. It is used to enable HIHs to submit provider service registration requests for multiple providers using a single batch bundle request. This profile manages the structured exchange of service-related information between healthcare providers and the esMD system by ensuring that service registration details such as service codes, provider information, and registration dates are captured accurately.

Usage:

• Examples for this Resource Profile: Bundle/TC004-BundlePractitioner, Bundle/TC005-BundlePractitioner, Bundle/TC006-BundlePractitioner and Bundle/TC007-BundlePractitioner
• CapabilityStatements using this Resource Profile: esMD FHIR Server Capability Statement

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
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 bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
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
Slices for profile	ΣC	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this ele-1: All FHIR elements must have a @value or children bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	SΣC	1..*	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
identifier	SΣ	0..1	Identifier	Persistent identifier for the bundle 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: batch
timestamp	SΣ	1..1	instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
total	SΣC	0..1	unsignedInt	If search, the total number of matches ele-1: All FHIR elements must have a @value or children
Slices for entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed 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:practitioner	ΣC	1..*	BackboneElement	Esmd Practitioner 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
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history) ele-1: All FHIR elements must have a @value or children
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
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. ele-1: All FHIR elements must have a @value or children Required Pattern: PUT
url	Σ	1..1	uri	URL for HTTP equivalent of this entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.type	required	Pattern: batch http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.request.method	required	Pattern: PUT http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:practitioner	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:practitioner	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Bundle.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
id	S	1..1	id	Logical id of this artifact
meta	S	0..1	EsmdMeta	Metadata about the resource
Slices for profile	C	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	S	1..*	Coding	Security Labels applied to this resource
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 Required Pattern: batch
timestamp	S	1..1	instant	When the bundle was assembled
total	S	0..1	unsignedInt	If search, the total number of matches
Slices for entry		1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource
entry:practitioner		1..*	BackboneElement	Esmd Practitioner
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
request		1..1	BackboneElement	Additional execution information (transaction/batch/history)
method		1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PUT
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0

Name	Flags	Card.	Type	Description & Constraints
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 bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
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
Slices for profile	ΣC	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	SΣC	1..*	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 Bindings Purpose AllLanguages Max Binding
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: batch
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	SΣ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	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed 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:practitioner	ΣC	1..*	BackboneElement	Esmd Practitioner 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
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	1..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. Required Pattern: PUT
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: batch http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.request.method	required	Pattern: PUT http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:practitioner	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:practitioner	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Bundle.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

Summary

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

Structures

This structure refers to these other structures:

• esMD Meta (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Meta)
• EsMD Practitioner (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Bundle.meta.profile (Closed)
• The element 1 is sliced based on the value of Bundle.entry (Closed)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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 bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
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
Slices for profile	ΣC	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this ele-1: All FHIR elements must have a @value or children bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	SΣC	1..*	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
identifier	SΣ	0..1	Identifier	Persistent identifier for the bundle 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: batch
timestamp	SΣ	1..1	instant	When the bundle was assembled ele-1: All FHIR elements must have a @value or children
total	SΣC	0..1	unsignedInt	If search, the total number of matches ele-1: All FHIR elements must have a @value or children
Slices for entry	ΣC	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed 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:practitioner	ΣC	1..*	BackboneElement	Esmd Practitioner 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
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
request	ΣC	1..1	BackboneElement	Additional execution information (transaction/batch/history) ele-1: All FHIR elements must have a @value or children
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
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. ele-1: All FHIR elements must have a @value or children Required Pattern: PUT
url	Σ	1..1	uri	URL for HTTP equivalent of this entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.type	required	Pattern: batch http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.request.method	required	Pattern: PUT http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:practitioner	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:practitioner	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Bundle.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

Differential View

This structure is derived from Bundle

Name	Flags	Card.	Type	Description & Constraints
Bundle	C	0..*	Bundle	Contains a collection of resources bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
id	S	1..1	id	Logical id of this artifact
meta	S	0..1	EsmdMeta	Metadata about the resource
Slices for profile	C	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	S	1..*	Coding	Security Labels applied to this resource
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 Required Pattern: batch
timestamp	S	1..1	instant	When the bundle was assembled
total	S	0..1	unsignedInt	If search, the total number of matches
Slices for entry		1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource
entry:practitioner		1..*	BackboneElement	Esmd Practitioner
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
request		1..1	BackboneElement	Additional execution information (transaction/batch/history)
method		1..1	code	GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: PUT
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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 bdl-profile: The bundle must declare conformance to the Esmd-BundleServiceRegistration profile
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
Slices for profile	ΣC	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this bundle-meta-profile-1: The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL bundle-meta-profile-2: The Bundle.meta.profile must not be empty
profile:esmdbundleserviceregistration	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration
security	SΣC	1..*	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 Bindings Purpose AllLanguages Max Binding
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: batch
timestamp	SΣ	1..1	instant	When the bundle was assembled
total	SΣ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	1..*	BackboneElement	Entry in the bundle - will have a resource or information Slice: Unordered, Closed 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:practitioner	ΣC	1..*	BackboneElement	Esmd Practitioner 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	Σ	0..1	uri	URI for resource (Absolute URL server address or URI for UUID/OID)
resource		1..1	EsmdPractitioner	A person with a formal responsibility in the provisioning of healthcare or related services
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	1..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. Required Pattern: PUT
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Bundle.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Bundle.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Bundle.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Bundle.type	required	Pattern: batch http://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard
Bundle.entry.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry.request.method	required	HTTPVerb http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.search.mode	required	SearchEntryMode http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard
Bundle.entry:practitioner.request.method	required	Pattern: PUT http://hl7.org/fhir/ValueSet/http-verb|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
bdl-1	error	Bundle	total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history')
bdl-2	error	Bundle	entry.search only when a search : entry.search.empty() or (type = 'searchset')
bdl-3	error	Bundle	entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4	error	Bundle	entry.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-5	error	Bundle.entry, Bundle.entry:practitioner	must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists()
bdl-7	error	Bundle	FullUrl 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-8	error	Bundle.entry, Bundle.entry:practitioner	fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not()
bdl-9	error	Bundle	A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10	error	Bundle	A document must have a date : type = 'document' implies (timestamp.hasValue())
bdl-11	error	Bundle	A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition)
bdl-12	error	Bundle	A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-profile	error	Bundle	The bundle must declare conformance to the Esmd-BundleServiceRegistration profile : meta.profile.where($this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration').exists()
bundle-meta-profile-1	error	Bundle.meta.profile	The Bundle.meta.profile must contain the Esmd-BundleServiceRegistration profile URL : $this = 'https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-BundleServiceRegistration'
bundle-meta-profile-2	error	Bundle.meta.profile	The Bundle.meta.profile must not be empty : $this.exists() and $this.length() > 0
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	Bundle.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')

This structure is derived from Bundle

Summary

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

Structures

This structure refers to these other structures:

• esMD Meta (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Meta)
• EsMD Practitioner (https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Bundle.meta.profile (Closed)
• The element 1 is sliced based on the value of Bundle.entry (Closed)

Other representations of profile: CSV, Excel, Schematron