Esmd List SubmissionSet Profile - ESMD FHIR Implementation Guide v1.0.0

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 List SubmissionSet Profile

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

The Esmd-ListSubmissionSet profile extends the HL7 List resource. It is used within the Esmd-BundleSubmission resource to transmit submission set metadata to the esMD System. Submission set metadata represents metadata and identifiers relevant to the submission of a specific clinical document to the esMD System.

Usage:

Use this Resource Profile: Esmd Bundle Submission Profile
Examples for this Resource Profile: List/Example-ListSubmissionSet and List/list-002-11
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
List	C	0..*	List	A list is a curated collection of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
meta	SΣ	0..1	EsmdMeta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
Slices for 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
profile:esmdlistsubmissionset	Σ	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-ListSubmissionSet
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
Slices for extension		5..*	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:organizationId	S	1..1	(Complex)	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		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-oid-format-check: Invalid OrganizationId format.
extension:intendedRecipient	S	1..1	code	Intended Recipient ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-IntendedRecipient 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	esMD support Lines of Business 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 Identifier 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 Identifier 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:splitNumber	S	0..1	string	Split Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-SplitNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attachmentControlNumber	S	0..1	(Complex)	Attachment Control Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-acn-1: ACN is optional element, if ACN is present, then length should be between 1 and 80 characters.
extension:responseTypeCategory	S	0..1	(Complex)	Response Type Category URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-rtc-1: Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters.
extension:uniqueId	S	1..1	(Complex)	Transaction 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		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
extension:npi	S	1..1	(Complex)	Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-npi-1: NPI should be 10 numeric
extension:parentUniqueId	S	0..1	(Complex)	Transaction Parent Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-puid-1: ParentUniqueId must be required element and length should be lessthan 64 character
identifier		0..*	Identifier	Business identifier ele-1: All FHIR elements must have a @value or children
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	Σ	0..1	string	Descriptive name for the list ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
subject	Σ	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	Σ	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
entry	C	1..*	BackboneElement	Entries in the list 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
item		1..1	Reference(Esmd Document Reference Profile)	Actual entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.meta.security	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
List.status	required	Pattern: current `http://hl7.org/fhir/ValueSet/list-status\|4.0.1` from the FHIR Standard
List.mode	required	Pattern: working `http://hl7.org/fhir/ValueSet/list-mode\|4.0.1` from the FHIR Standard
List.code	example	ExampleUseCodesForList `http://hl7.org/fhir/ValueSet/list-example-codes` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	List.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
List		0..*	List	A list is a curated collection of resources
meta	S	0..1	EsmdMeta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for profile				Content/Rules for all slices
profile:esmdlistsubmissionset		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListSubmissionSet
security	S	1..*	Coding	Security Labels applied to this resource
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:organizationId	S	1..1	(Complex)	Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
value[x]	C	1..1	string	Value of extension esmd-oid-format-check: Invalid OrganizationId format.
extension:intendedRecipient	S	1..1	code	Intended Recipient ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-IntendedRecipient Binding: ESMD ReviewContractorOIDs ValueSet (required)
extension:linesOfBusinessId	S	1..1	code	esMD support Lines of Business 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 Identifier URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
extension:caseId	S	0..1	string	Case Identifier URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
extension:splitNumber	S	0..1	string	Split Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-SplitNumber
extension:attachmentControlNumber	S	0..1	(Complex)	Attachment Control Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber
value[x]	C	1..1	string	Value of extension esmd-acn-1: ACN is optional element, if ACN is present, then length should be between 1 and 80 characters.
extension:responseTypeCategory	S	0..1	(Complex)	Response Type Category URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory
value[x]	C	1..1	string	Value of extension esmd-rtc-1: Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters.
extension:uniqueId	S	1..1	(Complex)	Transaction Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
value[x]	C	1..1	string	Value of extension esmd-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
extension:npi	S	1..1	(Complex)	Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI
value[x]	C	1..1	string	Value of extension esmd-npi-1: NPI should be 10 numeric
extension:parentUniqueId	S	0..1	(Complex)	Transaction Parent Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId
value[x]	C	1..1	string	Value of extension esmd-puid-1: ParentUniqueId must be required element and length should be lessthan 64 character
modifierExtension		0..0
identifier		0..*	Identifier	Business identifier
status	S	1..1	code	current \| retired \| entered-in-error Required Pattern: current
mode		1..1	code	working \| snapshot \| changes Required Pattern: working
title		0..1	string	Descriptive name for the list
code		0..1	CodeableConcept	What the purpose of this list is
subject		0..1	Reference(Patient \| Group \| Device \| Location)	If all resources have the same subject
encounter		0..0
date	S	1..1	dateTime	When the list was prepared
source		0..1	Reference(Practitioner \| PractitionerRole \| Patient \| Device)	Who and/or what defined the list contents (aka Author)
orderedBy		0..0
note		0..1	Annotation	Comments about the list
entry		1..*	BackboneElement	Entries in the list
flag		0..0
deleted		0..0
date		0..0
item		1..1	Reference(Esmd Document Reference Profile)	Actual entry
emptyReason		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

Description & Constraints

List

C

0..*

List

A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

List.meta.security

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

from the FHIR Standard

List.meta.tag

example

CommonTags

http://hl7.org/fhir/ValueSet/common-tags

from the FHIR Standard

List.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

required

Pattern: current

http://hl7.org/fhir/ValueSet/list-status|4.0.1

from the FHIR Standard

List.mode

required

Pattern: working

http://hl7.org/fhir/ValueSet/list-mode|4.0.1

from the FHIR Standard

List.code

example

ExampleUseCodesForList

http://hl7.org/fhir/ValueSet/list-example-codes

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	List.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 15 elements
Fixed: 1 element
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list is a curated collection of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
meta	SΣ	0..1	EsmdMeta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
Slices for 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
profile:esmdlistsubmissionset	Σ	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-ListSubmissionSet
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
Slices for extension		5..*	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:organizationId	S	1..1	(Complex)	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		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-oid-format-check: Invalid OrganizationId format.
extension:intendedRecipient	S	1..1	code	Intended Recipient ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-IntendedRecipient 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	esMD support Lines of Business 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 Identifier 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 Identifier 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:splitNumber	S	0..1	string	Split Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-SplitNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:attachmentControlNumber	S	0..1	(Complex)	Attachment Control Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-acn-1: ACN is optional element, if ACN is present, then length should be between 1 and 80 characters.
extension:responseTypeCategory	S	0..1	(Complex)	Response Type Category URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-rtc-1: Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters.
extension:uniqueId	S	1..1	(Complex)	Transaction 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		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
extension:npi	S	1..1	(Complex)	Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-npi-1: NPI should be 10 numeric
extension:parentUniqueId	S	0..1	(Complex)	Transaction Parent Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId"
value[x]	C	1..1	string	Value of extension ele-1: All FHIR elements must have a @value or children esmd-puid-1: ParentUniqueId must be required element and length should be lessthan 64 character
identifier		0..*	Identifier	Business identifier ele-1: All FHIR elements must have a @value or children
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	Σ	0..1	string	Descriptive name for the list ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children
subject	Σ	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	Σ	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
entry	C	1..*	BackboneElement	Entries in the list 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
item		1..1	Reference(Esmd Document Reference Profile)	Actual entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
List.meta.security	extensible	All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
List.status	required	Pattern: current `http://hl7.org/fhir/ValueSet/list-status\|4.0.1` from the FHIR Standard
List.mode	required	Pattern: working `http://hl7.org/fhir/ValueSet/list-mode\|4.0.1` from the FHIR Standard
List.code	example	ExampleUseCodesForList `http://hl7.org/fhir/ValueSet/list-example-codes` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	List.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Differential View

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
List		0..*	List	A list is a curated collection of resources
meta	S	0..1	EsmdMeta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for profile				Content/Rules for all slices
profile:esmdlistsubmissionset		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListSubmissionSet
security	S	1..*	Coding	Security Labels applied to this resource
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:organizationId	S	1..1	(Complex)	Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
value[x]	C	1..1	string	Value of extension esmd-oid-format-check: Invalid OrganizationId format.
extension:intendedRecipient	S	1..1	code	Intended Recipient ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-IntendedRecipient Binding: ESMD ReviewContractorOIDs ValueSet (required)
extension:linesOfBusinessId	S	1..1	code	esMD support Lines of Business 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 Identifier URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ClaimId
extension:caseId	S	0..1	string	Case Identifier URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-CaseId
extension:splitNumber	S	0..1	string	Split Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-SplitNumber
extension:attachmentControlNumber	S	0..1	(Complex)	Attachment Control Number URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-AttachmentControlNumber
value[x]	C	1..1	string	Value of extension esmd-acn-1: ACN is optional element, if ACN is present, then length should be between 1 and 80 characters.
extension:responseTypeCategory	S	0..1	(Complex)	Response Type Category URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ResponseTypeCategory
value[x]	C	1..1	string	Value of extension esmd-rtc-1: Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters.
extension:uniqueId	S	1..1	(Complex)	Transaction Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-UniqueId
value[x]	C	1..1	string	Value of extension esmd-uid-1: UniqueId must be a required element and its length should be less than or equal to 64 characters.
extension:npi	S	1..1	(Complex)	Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI
value[x]	C	1..1	string	Value of extension esmd-npi-1: NPI should be 10 numeric
extension:parentUniqueId	S	0..1	(Complex)	Transaction Parent Unique ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ParentUniqueId
value[x]	C	1..1	string	Value of extension esmd-puid-1: ParentUniqueId must be required element and length should be lessthan 64 character
modifierExtension		0..0
identifier		0..*	Identifier	Business identifier
status	S	1..1	code	current \| retired \| entered-in-error Required Pattern: current
mode		1..1	code	working \| snapshot \| changes Required Pattern: working
title		0..1	string	Descriptive name for the list
code		0..1	CodeableConcept	What the purpose of this list is
subject		0..1	Reference(Patient \| Group \| Device \| Location)	If all resources have the same subject
encounter		0..0
date	S	1..1	dateTime	When the list was prepared
source		0..1	Reference(Practitioner \| PractitionerRole \| Patient \| Device)	Who and/or what defined the list contents (aka Author)
orderedBy		0..0
note		0..1	Annotation	Comments about the list
entry		1..*	BackboneElement	Entries in the list
flag		0..0
deleted		0..0
date		0..0
item		1..1	Reference(Esmd Document Reference Profile)	Actual entry
emptyReason		0..0
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')

Snapshot View

Description & Constraints

List

C

0..*

List

A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet / Code URI

List.meta.security

extensible

All Security Labels

http://hl7.org/fhir/ValueSet/security-labels

from the FHIR Standard

List.meta.tag

example

CommonTags

http://hl7.org/fhir/ValueSet/common-tags

from the FHIR Standard

List.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

required

Pattern: current

http://hl7.org/fhir/ValueSet/list-status|4.0.1

from the FHIR Standard

List.mode

required

Pattern: working

http://hl7.org/fhir/ValueSet/list-mode|4.0.1

from the FHIR Standard

List.code

example

ExampleUseCodesForList

http://hl7.org/fhir/ValueSet/list-example-codes

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	List	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
esmd-acn-1	error	List.extension:attachmentControlNumber.value[x]	ACN is optional element, if ACN is present, then length should be between 1 and 80 characters. : value.exists() and value.matches('^[A-Za-z0-9-]{1,40}$')
esmd-npi-1	error	List.extension:npi.value[x]	NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$')
esmd-oid-format-check	error	List.extension:organizationId.value[x]	Invalid OrganizationId format. : value.exists() and value.matches('^(urn:oid:)([1-9][0-9](.[0-9]+))$')
esmd-puid-1	error	List.extension:parentUniqueId.value[x]	ParentUniqueId must be required element and length should be lessthan 64 character : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
esmd-rtc-1	error	List.extension:responseTypeCategory.value[x]	Response Type Category is optional element, if RTC is present, then length should be between 1 and 100 characters. : value.exists() and value.matches('^.{1,100}$')
esmd-uid-1	error	List.extension:uniqueId.value[x]	UniqueId must be a required element and its length should be less than or equal to 64 characters. : value.exists() and value.matches('^[A-Za-z0-9_-]{1,64}$')
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-esmd-meta-security-01	error	List.meta.security	esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST')
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 15 elements
Fixed: 1 element
Prohibited: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Other representations of profile: CSV, Excel, Schematron

IG © 2024+ CMS FHIR esMD. Package ESMD-FHIR-ImplementationGuide#1.0.0 based on FHIR 4.0.1. Generated 2025-06-11
Links: Table of Contents | QA Report