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 Provider Confirmation Profile
| Official URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-ListDeliveryConfirmation | Version: 1.0.0 | |||
| Draft as of 2024-02-25 | Computable Name: EsmdListDeliveryConfirmation | |||
The Esmd-ListDeliveryConfirmation profile extends the HL7 List resource. It is used to facilitate the efficient communication of Provider Delivery Success acknowledgements and Provider Delivery Failure acknowledgements back to a Review Contractor (RC) after an HIH delivers those clinical documents to the designated healthcare provider.
Usage:
- Use this Resource Profile: Esmd Bundle Delivery Conformation Profile
- Examples for this Resource Profile: List/9bad594a-cc5d-4024-9e6b-be4751bba064 and List/9bad594a-cc5d-4024-9e6b-be4751bba065
- 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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List |
SC | 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" |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
  meta |
SΣ | 0..1 | EsmdMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
  profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
 security |
SΣC | 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 contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this |
  contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources |
 Slices for extension |
4..* | 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:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:organizationId |
S | 1..1 | string | Sender 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:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
  extension |
0..0 | |||
| url |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId" | |
 value[x] |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics esmd-transid-1: Invalid format Transaction Id received. |
 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 |
| 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 |
 subject |
SΣ | 0..1 | Reference(Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children |
| source |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
0..1 | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| List.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | Pattern: workinghttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from 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-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transactionid-1 | error | List.extension:esMDTransactionId.value[x] | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') | |
| 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 |
S | 0..* | List | A list is a curated collection of resources |
 id |
S | 0..1 | id | Logical id of this artifact |
| meta |
S | 0..1 | EsmdMeta | Metadata about the resource |
| security |
S | 1..* | Coding | Security Labels applied to this resource |
| Slices for contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this |
| contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources |
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime |
| extension:organizationId |
S | 1..1 | string | Sender Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId |
| extension:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId |
| value[x] |
C | 1..1 | string | Value of extension esmd-transid-1: Invalid format Transaction Id received. |
| 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 |
 modifierExtension |
0..0 | |||
| status |
S | 1..1 | code | current | retired | entered-in-error Required Pattern: current |
| mode |
1..1 | code | working | snapshot | changes Required Pattern: working | |
| subject |
S | 0..1 | Reference(Patient) | If all resources have the same subject |
| encounter |
0..0 | |||
| date |
S | 1..1 | dateTime | When the list was prepared |
| source |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy |
0..0 | |||
| note |
0..1 | Annotation | Comments about the list | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| esmd-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
SC | 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 |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 0..1 | EsmdMeta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| security |
SΣC | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | ||||
| contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources | ||||
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime | ||||
| extension:organizationId |
S | 1..1 | string | Sender Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId | ||||
| extension:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId" | |||||
| value[x] |
C | 1..1 | string | Value of extension esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics esmd-transid-1: Invalid format Transaction Id received. | ||||
| extension:npi |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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 esmd-npi-1: NPI should be 10 numeric | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| subject |
SΣ | 0..1 | Reference(Patient) | If all resources have the same subject | ||||
| date |
SΣ | 1..1 | dateTime | When the list was prepared | ||||
| source |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| note |
0..1 | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| List.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| List.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | Pattern: workinghttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transactionid-1 | error | List.extension:esMDTransactionId.value[x] | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') | |
| 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(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of List.contained
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
SC | 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" |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| meta |
SΣ | 0..1 | EsmdMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
| security |
SΣC | 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 contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this |
| contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources |
| Slices for extension |
4..* | 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:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:organizationId |
S | 1..1 | string | Sender 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:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId" | |
| value[x] |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics esmd-transid-1: Invalid format Transaction Id received. |
| 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 |
| 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 |
| subject |
SΣ | 0..1 | Reference(Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children |
| source |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
0..1 | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI |
| List.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | Pattern: workinghttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from 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-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transactionid-1 | error | List.extension:esMDTransactionId.value[x] | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') | |
| 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 |
S | 0..* | List | A list is a curated collection of resources |
| id |
S | 0..1 | id | Logical id of this artifact |
| meta |
S | 0..1 | EsmdMeta | Metadata about the resource |
| security |
S | 1..* | Coding | Security Labels applied to this resource |
| Slices for contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this |
| contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources |
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime |
| extension:organizationId |
S | 1..1 | string | Sender Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId |
| extension:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId |
| value[x] |
C | 1..1 | string | Value of extension esmd-transid-1: Invalid format Transaction Id received. |
| 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 |
| modifierExtension |
0..0 | |||
| status |
S | 1..1 | code | current | retired | entered-in-error Required Pattern: current |
| mode |
1..1 | code | working | snapshot | changes Required Pattern: working | |
| subject |
S | 0..1 | Reference(Patient) | If all resources have the same subject |
| encounter |
0..0 | |||
| date |
S | 1..1 | dateTime | When the list was prepared |
| source |
S | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy |
0..0 | |||
| note |
0..1 | Annotation | Comments about the list | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| esmd-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
SC | 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 |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
SΣ | 0..1 | EsmdMeta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| security |
SΣC | 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| Slices for contained |
S | 1..* | Resource | Contained, inline Resources Slice: Unordered, Open by profile:$this | ||||
| contained:Esmd-OperationOutcome |
S | 1..* | Resource | Contained, inline Resources | ||||
| Slices for extension |
4..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deliveryDate |
S | 1..1 | string | Provider Delivery Confirmation Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime | ||||
| extension:organizationId |
S | 1..1 | string | Sender Organization ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId | ||||
| extension:esMDTransactionId |
S | 1..1 | (Complex) | esMD Transaction ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId" | |||||
| value[x] |
C | 1..1 | string | Value of extension esmd-transactionid-1: esMD Transaction ID must be required element and length should be 15 AlphaNumerics esmd-transid-1: Invalid format Transaction Id received. | ||||
| extension:npi |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| 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 esmd-npi-1: NPI should be 10 numeric | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Required Pattern: working | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| subject |
SΣ | 0..1 | Reference(Patient) | If all resources have the same subject | ||||
| date |
SΣ | 1..1 | dateTime | When the list was prepared | ||||
| source |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| note |
0..1 | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | URI | |||
| List.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| List.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | Pattern: workinghttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codesfrom the FHIR Standard | ||||
| List.entry.flag | example | PatientMedicineChangeTypeshttp://hl7.org/fhir/ValueSet/list-item-flagfrom the FHIR Standard | ||||
| List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom 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-npi-1 | error | List.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-transactionid-1 | error | List.extension:esMDTransactionId.value[x] | esMD Transaction ID must be required element and length should be 15 AlphaNumerics : value.matches('^[A-Za-z0-9]{15}$') | |
| esmd-transid-1 | error | List.extension:esMDTransactionId.value[x] | Invalid format Transaction Id received. : value.exists() and value.matches('^[A-Za-z0-9]{15}$') | |
| 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(1 nested mandatory element)
Must-Support: 13 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-DeliveryDateTime
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-OrganizationId
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-TransactionId
- https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of List.contained
Other representations of profile: CSV, Excel, Schematron