v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: XTN (Data Structure)

Official URL: http://hl7.org/fhir/StructureDefinition/XTN Version: 2.9
Draft as of 2023-08-09 Responsible: FO Computable Name: XTN

Copyright/Legal: FO

Extended Telecommunication Number

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1-Telephone Number
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 4 0..1STCommunication Address
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorXTNIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorXTNIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorXTNIf 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-5errorXTNIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceXTNA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... 1 0..1-Telephone Number
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 4 0..1STCommunication Address
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
XTN.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorXTNIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorXTNIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorXTNIf 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-5errorXTNIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceXTNA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (1 nested mandatory element)

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... 1 0..1-Telephone Number
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 4 0..1STCommunication Address
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorXTNIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorXTNIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorXTNIf 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-5errorXTNIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceXTNA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. XTN 1..1DomainResource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
A resource with narrative, extensions, and contained resources
Instances of this logical model are not marked to be the target of a Reference
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... 1 0..1-Telephone Number
... 2 0..1IDTelecommunication Use Code
... 3 1..1IDTelecommunication Equipment Type
... 4 0..1STCommunication Address
... 5 0..1SNMCountry Code
... 6 0..1SNMArea/City Code
... 7 0..1SNMLocal Number
... 8 0..1SNMExtension
... 9 0..1STAny Text
... 10 0..1STExtension Prefix
... 11 0..1STSpeed Dial Code
... 12 0..1STUnformatted Telephone Number
... 13 0..1DTMEffective Start Date
... 14 0..1DTMExpiration Date
... 15 0..1CWEExpiration Reason
... 16 0..1CWEProtection Code
... 17 0..1EIShared Telecommunication Identifier
... 18 0..1NMPreference Order

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
XTN.languagerequiredAllLanguages

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorXTNIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorXTNIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorXTNIf 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-5errorXTNIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceXTNA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element (1 nested mandatory element)

 

Other representations of profile: CSV, Excel