SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Data Type Profile: SPLContactPoint

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/SPLContactPoint Version: 0.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: SPLContactPoint

SPL-specific Constraints on the ContactPoint dealing with proper formatting

Usage:

Formal Views of Profile Content

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

This structure is derived from ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... system S 1..1 code phone | fax | email | pager | url | sms | other
... value S 1..1 string The actual contact point details

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
ele-1: All FHIR elements must have a @value or children
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
... value SΣC 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ContactPoint.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
... period Σ 0..1 Period Time period when the contact point was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ContactPoint.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.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()
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

This structure is derived from ContactPoint

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Maturity: 1

Differential View

This structure is derived from ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... system S 1..1 code phone | fax | email | pager | url | sms | other
... value S 1..1 string The actual contact point details

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
ele-1: All FHIR elements must have a @value or children
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
... value SΣC 1..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ContactPoint.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C 0..* ContactPoint Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
spl-2.1.7.x: Telephone and fax numbers are formatted properly
spl-2.1.7.11: Emails are formatted properly
... id 0..1 id Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
... period Σ 0..1 Period Time period when the contact point was/is in use

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ContactPoint.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
ContactPoint.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorContactPointA system is required if a value is provided.
: value.empty() or system.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()
spl-2.1.7.11errorContactPointEmails are formatted properly
: system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$')
spl-2.1.7.xerrorContactPointTelephone and fax numbers are formatted properly
: (system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$')

This structure is derived from ContactPoint

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron