Shared Health Specification and Guide Version 5.0

 

3.53 StructureDefinition: Shared Health ContactPoint

The official URL for this profile is: 

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-contactpoint

3.53.2 Formal Views of Profile Content

Download Excel representation

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

>

This structure is derived from ContactPoint

NameCard.TypeConstraints and Usage
.  ContactPoint 0..*ContactPointcpt-2: A system is required if a value is provided.
Definition:
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (confidential) 		0..1Contact Point is ConfidentialDefinition:
If true, indicates that the contact point is considered to be confidential and should be disclosed only in limited circumstances


Comments:
Conformance Rule: If the phone number is not to be published, set value to 'true'.

..  system 1..1codeBinding: SharedContactPointSystem (20190415) (required)
Definition:
Telecommunications form for contact point - what communications system is required to make use of the contact.

..  value 1..1stringDefinition:
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone/fax number or email address).


Comments:
Usage Note: When sending a phone or fax value the format can be sent as (123) 456-7890 x 11111 to aid in readability purposes when it is being displayed as received.

..  use 1..1codeBinding: SharedContactPointUse (20190415) (required)
Definition:
Identifies the purpose for the contact point.


Comments:
Binding value set defined. (home, mobile, work)

This structure is derived from ContactPoint

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

This structure is derived from ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contactpoint-confidential S0..1booleanContact Point is Confidential
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential
... system S1..1codephone | fax | email
Binding: SharedContactPointSystem (20190415) (required)
... value S1..1stringThe actual contact point details
... use ?!S1..1codehome | mobile | work
Binding: SharedContactPointUse (20190415) (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint I0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... id 0..1idxml:id (or equivalent in JSON)
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contactpoint-confidential S0..1booleanContact Point is Confidential
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential
... system SΣI1..1codephone | fax | email
Binding: SharedContactPointSystem (20190415) (required)
... value SΣ1..1stringThe actual contact point details
... use ?!SΣ1..1codehome | mobile | work
Binding: SharedContactPointUse (20190415) (required)
... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
... period Σ0..1PeriodTime period when the contact point was/is in use

doco Documentation for this format

Grid View

This structure is derived from ContactPoint

NameCard.TypeConstraints and Usage
.  ContactPoint 0..*ContactPointcpt-2: A system is required if a value is provided.
Definition:
Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (confidential) 		0..1Contact Point is ConfidentialDefinition:
If true, indicates that the contact point is considered to be confidential and should be disclosed only in limited circumstances


Comments:
Conformance Rule: If the phone number is not to be published, set value to 'true'.

..  system 1..1codeBinding: SharedContactPointSystem (20190415) (required)
Definition:
Telecommunications form for contact point - what communications system is required to make use of the contact.

..  value 1..1stringDefinition:
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone/fax number or email address).


Comments:
Usage Note: When sending a phone or fax value the format can be sent as (123) 456-7890 x 11111 to aid in readability purposes when it is being displayed as received.

..  use 1..1codeBinding: SharedContactPointUse (20190415) (required)
Definition:
Identifies the purpose for the contact point.


Comments:
Binding value set defined. (home, mobile, work)

This structure is derived from ContactPoint

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contactpoint-confidential S0..1booleanContact Point is Confidential
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential
... system S1..1codephone | fax | email
Binding: SharedContactPointSystem (20190415) (required)
... value S1..1stringThe actual contact point details
... use ?!S1..1codehome | mobile | work
Binding: SharedContactPointUse (20190415) (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint I0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... id 0..1idxml:id (or equivalent in JSON)
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-contactpoint-confidential S0..1booleanContact Point is Confidential
URL: http://sharedhealth.exchange/fhir/StructureDefinition/ext-contactpoint-confidential
... system SΣI1..1codephone | fax | email
Binding: SharedContactPointSystem (20190415) (required)
... value SΣ1..1stringThe actual contact point details
... use ?!SΣ1..1codehome | mobile | work
Binding: SharedContactPointUse (20190415) (required)
... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
... period Σ0..1PeriodTime period when the contact point was/is in use

doco Documentation for this format

 

Other representations of profile: Schematron

3.53.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ContactPoint.systemrequiredSharedContactPointSystem
ContactPoint.userequiredSharedContactPointUse

3.53.4 Constraints

Constraints

IdPathDetailsRequirements
cpt-2ContactPointA system is required if a value is provided.
: value.empty() or system.exists()