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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ContactPoint
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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]+)?$') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣC | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | ContactPoint | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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]+)?$') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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. |
value | SΣC | 1..1 | string | The actual contact point details |
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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | ContactPoint | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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
Differential View
This structure is derived from ContactPoint
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
value | SΣC | 1..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | ContactPoint | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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. |
value | SΣC | 1..1 | string | The actual contact point details |
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 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ContactPoint.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
ContactPoint.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | ContactPoint | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
spl-2.1.7.11 | error | ContactPoint | Emails are formatted properly : system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$') | |
spl-2.1.7.x | error | ContactPoint | Telephone 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
Other representations of profile: CSV, Excel, Schematron