Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build

Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions

Data Type Profile: zib ContactInformation EmailAddresses ( Abstract )

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses Version: 0.9.0
Draft as of 2023-10-17 Computable Name: ZibContactInformationEmailAddresses

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

Contact information includes a person’s telephone numbers en e-mail addresses.

This ContactPoint resource represents the EmailAddresses concept of the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) ContactInformation v1.2 (2020).

To implement the entire zib, the complementary profile zib-ContactInformation-TelephoneNumbers should be used. Both profiles can be added in a slice with the discriminator set to profile/$this.

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 0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... system 1..1codeemail
Required Pattern: email
... value 0..1stringEmailAddress
... use 0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... system ΣC1..1codeemail
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... value Σ0..1stringEmailAddress
... use ?!Σ0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ContactPoint.systemrequiredPattern: email
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse

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())
NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... system ΣC1..1codeemail
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... use ?!Σ0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.

... 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

Terminology Bindings

PathConformanceValueSet / Code
ContactPoint.systemrequiredPattern: email
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse

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()

This structure is derived from ContactPoint

Summary

Mandatory: 1 element

Differential View

This structure is derived from ContactPoint

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint 0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... system 1..1codeemail
Required Pattern: email
... value 0..1stringEmailAddress
... use 0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... system ΣC1..1codeemail
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... value Σ0..1stringEmailAddress
... use ?!Σ0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ContactPoint.systemrequiredPattern: email
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse

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())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactPoint C0..*ContactPointThis is an abstract profile. Child profiles: NlcoreContactInformationEmailAddresses
EmailAddresses
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... system ΣC1..1codeemail
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
... use ?!Σ0..1codeEmailAddressType
Binding: http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.

... 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

Terminology Bindings

PathConformanceValueSet / Code
ContactPoint.systemrequiredPattern: email
ContactPoint.userequiredhttp://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse

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()

This structure is derived from ContactPoint

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel, Schematron