{
"description": "Contact information includes a person's telephone numbers en e-mail addresses.",
"_filename": "nl-core-ContactInformation-EmailAddresses.json",
"package_name": "nictiz.fhir.nl.r4.nl-core",
"date": null,
"derivation": "constraint",
"publisher": "Nictiz",
"fhirVersion": "4.0.1",
"purpose": "A derived profile from [zib-ContactInformation-EmailAddresses](http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses) to provide a version better suited for implementation purposes. This profile augments the base profile with elements found in the various use cases that have adopted the zib.\r\n\r\nTo implement the entire zib, the complementary profile [nl-core-ContactInformation-TelephoneNumbers](http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-TelephoneNumbers) should be used. Both profiles can be added in a slice with the discriminator set to `profile`/`$this`.",
"name": "NlcoreContactInformationEmailAddresses",
"mapping": [ {
"uri": "https://zibs.nl/wiki/ContactInformation-v1.2(2020EN)",
"name": "zib ContactInformation-v1.2(2020EN)",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"abstract": false,
"copyright": "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.",
"type": "ContactPoint",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "nl core ContactInformation EmailAddresses",
"package_version": "0.12.0-beta.4",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "cpt-2",
"human": "A system is required if a value is provided.",
"xpath": "not(exists(f:value)) or exists(f:system)",
"severity": "error",
"expression": "value.empty() or system.exists()"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint",
"min": 0,
"definition": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.",
"isModifier": false,
"short": "EmailAddresses",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "XTN",
"identity": "v2"
}, {
"map": "TEL",
"identity": "rim"
}, {
"map": "ContactPoint",
"identity": "servd"
}, {
"map": "NL-CM:20.6.3",
"comment": "EmailAddresses",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode": "4.0.0"
} ],
"alias": [ "EmailAdressen", "nl-core-ContactInformation-EmailAddresses" ],
"max": "*",
"id": "ContactPoint",
"condition": [ "ele-1" ],
"comment": "Implementation of the \"EmailAddresses\" concept of zib ContactInformation.",
"base": {
"max": "*",
"min": 0,
"path": "ContactPoint"
}
}, {
"path": "ContactPoint.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ContactPoint.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ContactPoint.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ContactPoint.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.system",
"min": 1,
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"isModifier": false,
"short": "email",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"patternCode": "email",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointSystem"
} ],
"description": "Telecommunications form for contact point."
},
"max": "1",
"id": "ContactPoint.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 0,
"definition": "The person's e-mail address",
"isModifier": false,
"short": "EmailAddress",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "NL-CM:20.6.7",
"comment": "EmailAddress",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "EmailAdres" ],
"max": "1",
"id": "ContactPoint.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 0,
"definition": "EmailAddressType indicates whether it is a private or business e-mail address.",
"isModifier": true,
"short": "EmailAddressType",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
}, {
"map": "NL-CM:20.6.8",
"comment": "EmailAddressType",
"identity": "zib-contactinformation-v1.2-2020EN"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://nictiz.nl/fhir/ValueSet/ContactInformation-EmailAddressesUse",
"_valueSet": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap",
"valueCanonical": "http://nictiz.nl/fhir/ConceptMap/EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse"
} ]
},
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactPointUse"
} ],
"description": "Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse."
},
"alias": [ "EmailSoort" ],
"max": "1",
"id": "ContactPoint.use",
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"isModifier": false,
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "ContactPoint.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ContactPoint.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"isModifier": false,
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "ContactPoint.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "7cd13cf9-e7d9-4b14-83c3-64e348c6d8fc",
"kind": "complex-type",
"url": "http://nictiz.nl/fhir/StructureDefinition/nl-core-ContactInformation-EmailAddresses",
"version": null,
"differential": {
"element": [ {
"id": "ContactPoint",
"path": "ContactPoint",
"alias": [ "nl-core-ContactInformation-EmailAddresses" ]
} ]
},
"contact": [ {
"name": "Nictiz",
"telecom": [ {
"use": "work",
"value": "https://www.nictiz.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-EmailAddresses"
}