{ "resourceType": "StructureDefinition", "id": "nl-core-relatedperson", "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson", "version": "2.0.2", "name": "nl-core-relatedperson", "title": "nl-core-relatedperson", "status": "active", "publisher": "HL7 Netherlands", "contact": [ { "name": "Nictiz", "telecom": [ { "system": "email", "value": "info@nictiz.nl", "use": "work" } ] } ], "description": "A RelatedPerson resource as defined by the Dutch Health and Care Information models or HCIM (Dutch: Zorginformatieb1ouwsteen or ZIB) ContactPersoon version 3.1 (Release 2017). The HCIM ContactPerson is meant to deal with both related persons and contacts. This profile targets instantiations of the HCIM ContactPerson who are related persons. An HCIM ContactPerson who is a contact for a patient, belongs in Patient.contact. If a person is both a related person and a contact person, then some data duplication is inevitable. This may or may not be resolved in a future version of the Patient/RelatedPerson resources.", "purpose": "Recording relevant information to identify the contacts.", "copyright": "CC0", "fhirVersion": "3.0.2", "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "uri": "https://zibs.nl/wiki/ContactPerson-v1.2(2015EN)", "name": "HCIM ContactPerson-v1.2(2015EN)" }, { "identity": "hcim-contactperson-v3.0-2016EN", "uri": "https://zibs.nl/wiki/ContactPerson-v3.0(2016EN)", "name": "HCIM ContactPerson-v3.0(2016EN)" }, { "identity": "hcim-contactperson-v3.1-2017EN", "uri": "https://zibs.nl/wiki/ContactPerson-v3.1(2017EN)", "name": "HCIM ContactPerson-v3.1(2017EN)" }, { "identity": "hcim-contactinformation-v2.0.1-2015EN", "uri": "https://zibs.nl/wiki/Patient-v2.0.1(2015EN)", "name": "HCIM Patient-v2.0.1(2015EN)", "comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs" }, { "identity": "hcim-contactinformation-v3.0-2016EN", "uri": "https://zibs.nl/wiki/Patient-v3.0(2016EN)", "name": "HCIM Patient-v3.0(2016EN)", "comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs." }, { "identity": "hcim-contactinformation-v1.0-2017EN", "uri": "https://zibs.nl/wiki/ContactInformation-v1.0(2017EN)", "name": "HCIM ContactInformation-v1.0(2017EN)", "comment": "ContactInformation has become an independent information model as of release 2017 of the HCIMs." }, { "identity": "hcim-payer-v1.2-2015EN", "uri": "https://zibs.nl/wiki/Payer-v1.2(2015EN)", "name": "HCIM Payer-v1.2(2015EN)" }, { "identity": "hcim-payer-v3.0-2016EN", "uri": "https://zibs.nl/wiki/Payer-v3.0(2016EN)", "name": "HCIM Payer-v3.0(2016EN)" }, { "identity": "hcim-payer-v3.1-2017EN", "uri": "https://zibs.nl/wiki/Payer-v3.1(2017EN)", "name": "HCIM Payer-v3.1(2017EN)" }, { "identity": "hcim-basicelements-v1.0-2017EN", "uri": "https://zibs.nl/wiki/BasicElements-v1.0(2017EN)", "name": "HCIM BasicElements-v1.0(2017EN)" } ], "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "derivation": "constraint", "snapshot": { "element": [ { "id": "RelatedPerson", "path": "RelatedPerson", "short": "An person that is related to a patient, but who is not a direct target of care", "definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", "min": 0, "max": "*", "base": { "path": "Resource", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "role" }, { "identity": "w5", "map": "administrative.individual" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.5", "comment": "RelatedPersonAsInformationSource::ContactPerson" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.10", "comment": "RelatedPersonAsAuthor::ContactPerson" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.13", "comment": "RelatedPersonAsSubject::ContactPerson" } ] }, { "id": "RelatedPerson.id", "path": "RelatedPerson.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.meta", "path": "RelatedPerson.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.implicitRules", "path": "RelatedPerson.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.language", "path": "RelatedPerson.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language." }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.text", "path": "RelatedPerson.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "ele-1", "dom-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "rim", "map": "Act.text?" } ] }, { "id": "RelatedPerson.contained", "path": "RelatedPerson.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.extension", "path": "RelatedPerson.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.extension:role", "path": "RelatedPerson.extension", "sliceName": "role", "short": "Role", "definition": "Defines the role of the contact in relation to the patient.", "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.", "alias": [ "extensions", "user content", "Rol" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.2", "comment": "Role" } ] }, { "id": "RelatedPerson.extension:role.id", "path": "RelatedPerson.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "comment": "Note that FHIR strings may not exceed 1MB in size", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.extension:role.extension", "path": "RelatedPerson.extension.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.extension:role.url", "path": "RelatedPerson.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role", "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.extension:role.valueCodeableConcept:valueCodeableConcept", "path": "RelatedPerson.extension.valueCodeableConcept", "sliceName": "valueCodeableConcept", "short": "Role", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "alias": [ "Rol" ], "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "binding": { "strength": "extensible" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.2", "comment": "Role" } ] }, { "id": "RelatedPerson.modifierExtension", "path": "RelatedPerson.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "short": "A human identifier for this person", "definition": "Identifier for a person within a particular scope.", "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)" }, { "identity": "rim", "map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" }, { "identity": "servd", "map": "Identifier" }, { "identity": "v2", "map": "NK1-33" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.6", "comment": "IdentificationNumber" } ] }, { "id": "RelatedPerson.active", "path": "RelatedPerson.active", "short": "Whether this related person's record is in active use", "definition": "Whether this related person record is in active use.", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] }, { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "short": "The patient this person is related to", "definition": "The patient this person is related to.", "comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.", "requirements": "We need to know which patient this RelatedPerson is related to.", "min": 1, "max": "1", "base": { "path": "RelatedPerson.patient", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-patient" ] } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "ref-1", "severity": "error", "human": "SHALL have a contained resource if a local reference is provided", "expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))", "xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)" }, { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.11", "comment": "Subject" } ] }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "short": "Relationship", "definition": "Defines the contact’s familial relationship to the patient.", "comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.", "requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.", "alias": [ "Relatie" ], "min": 0, "max": "1", "base": { "path": "RelatedPerson.relationship", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientRelationshipType" } ], "strength": "extensible", "description": "The nature of the relationship between a patient and the related person" }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "CE/CNE/CWE" }, { "identity": "rim", "map": "CD" }, { "identity": "orim", "map": "fhir:CodeableConcept rdfs:subClassOf dt:CD" }, { "identity": "v2", "map": "NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "w5", "map": "class" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.3", "comment": "Relationship" } ] }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "short": "NameInformation", "definition": "Full name of the contact.", "comment": "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.\r\n\r\nA Dutch HumanName is a proper FHIR HumanName. Systems that do not understand any of the extensions, will be able to render and work with a Dutch name. Dutch names make certain name parts seaprately communicable. These parts are required for use in true Dutch systems when dealing with Dutch names, but may not have value for international systems when information gets sent abroad.\r\n\r\nTo have true compatibility an implementer SHOULD use the core HumanName parts as intended. To have names work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\nThe extension elements cover birth name (NL: eigennaam / geslachtsnaam) and partner/spouse name. Both may have a prefix (NL: voorvoegsel). When a person marries, he or she may keep their own name, assume the partner name, append the partner name to their own name, or the other way around.\r\n\r\nFor this reason, there are extensions for marking each part for what it is. \r\n\r\nExample: miss Irma Jongeneel marries mister de Haas and assumes the name Irma Jongeneel-de Haas\r\nfamily = \"Jongeneel-de Haas\"\r\ngiven = \"Irma\"\r\nhumanname-own-name = \"Jongeneel\"\r\nhumanname-partner-prefix = \"de \"\r\nhumanname-partner-name = \"Haas\"", "requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.", "alias": [ "Naamgegevens" ], "min": 0, "max": "*", "base": { "path": "RelatedPerson.name", "min": 0, "max": "*" }, "type": [ { "code": "HumanName", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname" ] } ], "example": [ { "label": "Structured HumanName (preferred above unstructured)", "valueHumanName": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order", "valueCode": "NL4" } ], "use": "official", "family": "Jongeneel-de Haas", "_family": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name", "valueString": "Jongeneel" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix", "valueString": "de" }, { "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", "valueString": "Haas" } ] }, "given": [ "Irma", "I." ], "_given": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "CL" } ] }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier", "valueCode": "IN" } ] } ] } }, { "label": "Unstructured HumanName", "valueHumanName": { "use": "official", "text": "Irma Jongeneel-de Haas" } } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "nl-core-humanname-1", "severity": "error", "human": "if you specify a prefix for an own name then an own name is also expected", "expression": "name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()", "xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-own-name']" }, { "key": "nl-core-humanname-2", "severity": "error", "human": "if you specify a voorvoegsel for a partner name then a partner name is also expected", "expression": "name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()", "xpath": "not(f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix']) or f:extension[@url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name']" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XPN" }, { "identity": "rim", "map": "EN (actually, PN)" }, { "identity": "servd", "map": "ProviderName" }, { "identity": "v2", "map": "NK1-2" }, { "identity": "rim", "map": "name" }, { "identity": "hcim-nameinformation-v2.0.1-2015EN", "map": "NL-CM:0.1.6", "comment": "NameInformation" }, { "identity": "hcim-nameinformation-v3.0-2016EN", "map": "NL-CM:0.1.6", "comment": "NameInformation" }, { "identity": "hcim-nameinformation-v1.0.1-2017EN", "map": "NL-CM:20.4.1", "comment": "NameInformation" }, { "identity": "BRP", "map": "02", "comment": "Naam" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.4", "comment": "Name" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.4", "comment": "Name" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.4", "comment": "NameInformation" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.5", "comment": "PayerName" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.5", "comment": "PayerName" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.5", "comment": "PayerName" } ] }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "short": "ContactInformation", "definition": "Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension.\r\n\r\n | HCIM | .ext:TelecomType | .system | .use |\r\n |----------------------------------------------------|------------------|---------|--------|\r\n | Primary Home Land Line | LL | phone | home |\r\n | Temporary Land Line | LL | phone | temp |\r\n | Primary Work Land Line | LL | phone | work |\r\n | | | | |\r\n | Primary Home Fax | FAX | fax | home |\r\n | Temporary Fax | FAX | fax | temp |\r\n | Primary Work Fax | FAX | fax | work |\r\n | | | | |\r\n | Primary Home Mobile Phone | MC | phone | home |\r\n | Temporary Mobile Phone | MC | phone | temp |\r\n | Primary Work Mobile Phone | MC | phone | work |\r\n | | | | |\r\n | Primary Home Pager | PG | pager | home |\r\n | Temporary Pager | PG | pager | temp |\r\n | Primary Work Pager | PG | pager | work |\r\n | | | | |\r\n | Private email address | | email | home |\r\n | Work email address | | email | work |\r\n | | | | |\r\n | Mobile phone number undetermined private/business | | phone | mobile |", "comment": "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "alias": [ "Contactgegevens" ], "min": 0, "max": "*", "base": { "path": "RelatedPerson.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint" ] } ], "example": [ { "label": "Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.", "valueContactPoint": { "system": "phone", "value": "+31611234567", "use": "work" } }, { "label": "Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.", "valueContactPoint": { "system": "phone", "value": "+31611234567", "use": "mobile" } }, { "label": "Primary Home Land Line", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "LL", "display": "Land Line" } ] } } ], "system": "phone", "value": "...", "use": "home" } }, { "label": "Temporary Land Line", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "LL", "display": "Land Line" } ] } } ], "system": "phone", "value": "...", "use": "temp" } }, { "label": "Primary Work Land Line", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "LL", "display": "Land Line" } ] } } ], "system": "phone", "value": "...", "use": "work" } }, { "label": "Primary Home Fax", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "FAX", "display": "Fax" } ] } } ], "system": "fax", "value": "...", "use": "home" } }, { "label": "Temporary Fax", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "FAX", "display": "Fax" } ] } } ], "system": "fax", "value": "...", "use": "temp" } }, { "label": "Primary Work Fax", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1", "code": "FAX", "display": "Fax" } ] } } ], "system": "fax", "value": "...", "use": "work" } }, { "label": "Primary Home Mobile Phone", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "MC", "display": "Mobile Phone" } ] } } ], "system": "phone", "value": "...", "use": "home" } }, { "label": "Temporary Mobile Phone", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "MC", "display": "Mobile Phone" } ] } } ], "system": "phone", "value": "...", "use": "temp" } }, { "label": "Primary Work Mobile Phone", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "MC", "display": "Mobile Phone" } ] } } ], "system": "phone", "value": "...", "use": "work" } }, { "label": "Primary Home Pager", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "PG", "display": "Pager" } ] } } ], "system": "pager", "value": "...", "use": "home" } }, { "label": "Temporary Pager", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "PG", "display": "Pager" } ] } } ], "system": "pager", "value": "...", "use": "temp" } }, { "label": "Primary Work Pager", "valueContactPoint": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "PG", "display": "Pager" } ] } } ], "system": "pager", "value": "...", "use": "work" } }, { "label": "Private email address", "valueContactPoint": { "system": "email", "value": "giesput@myweb.nl", "use": "home" } }, { "label": "Work email address", "valueContactPoint": { "system": "email", "value": "example@workplace.nl", "use": "work" } } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "cpt-2", "severity": "error", "human": "A system is required if a value is provided.", "expression": "value.empty() or system.exists()", "xpath": "not(exists(f:value)) or exists(f:system)" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XTN" }, { "identity": "rim", "map": "TEL" }, { "identity": "servd", "map": "ContactPoint" }, { "identity": "v2", "map": "NK1-5 / NK1-6 / NK1-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "hcim-contactinformation-v2.0.1-2015EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v3.0-2016EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v1.0-2017EN", "map": "NL-CM:20.6.1", "comment": "ContactInformation" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.6", "comment": "TelephoneE-mail" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.6", "comment": "TelephoneE-mail" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.6", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v1.0-2017EN", "map": "NL-CM:20.6.4", "comment": "TelephoneNumber" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.12", "comment": "TelephoneE-mail" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.12", "comment": "TelephoneE-mail" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.12", "comment": "ContactInformation" } ] }, { "id": "RelatedPerson.gender", "path": "RelatedPerson.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "comment": "Note that FHIR strings may not exceed 1MB in size", "requirements": "Needed for identification of the person, in combination with (at least) name and birth date.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.gender", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The gender of a person used for administrative purposes." }, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "NK1-15" }, { "identity": "rim", "map": "administrativeGender" } ] }, { "id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "short": "The date on which the related person was born", "definition": "The date on which the related person was born.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.birthDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "rim", "map": "player.birthTime" } ] }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "short": "AddressInformation", "definition": "This datatype defines a common basis for expressing all addresses around the world, but adds extensions to express Dutch addresses specifically, according to the HCIM AddressInformation (v1.0, 2017). A Dutch Address still is a proper FHIR Address, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype.\r\n\r\nTo have true compatibility an implementer SHOULD use the core Address parts as intended. To have addresses work for Dutch context, the implementer SHOULD in addition use the extension elements.\r\n\r\n**Separate address parts**\r\n\r\nThe first addition is that Dutch addresses make certain address parts separately communicable. These parts are required for use in true Dutch systems when dealing with Dutch addresses, but may not have value for international systems when information gets sent abroad.\r\n\r\n**Custom address types**\r\n\r\nThe second addition is that the HCIM defines its own ValueSet for address types, which can only be partially expressed using the FHIR Address datatype and requires a mapping to multiple elements. The table below explains how the HCIM concepts are mapped to the various FHIR elements (see the ConceptMaps http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressUse and http://nictiz.nl/fhir/ConceptMap/AdresSoortCodelijst-to-AddressType as well). The HCIM code itself should also be included using the AddressType extension.\r\n\r\n | HCIM | .ext:AddressType | .ext:official | .use | .type |\r\n\r\n |-----------------------------------|------------------|---------------|------|----------|\r\n\r\n | Postal Address/Postadres | PST | | | postal |\r\n\r\n | Primary Home/Officieel adres | HP | true | home | |\r\n\r\n | Visit Address/Woon-/verblijfadres | PHYS | | home | physical |\r\n\r\n | Temporary Address/Tijdelijk adres | TMP | | temp | |\r\n\r\n | Work Place/Werkadres | WP | | work | |\r\n\r\n | Vacation Home/Vakantie adres | HV | | temp | |\r\n\r\n If Address.type is \"both\" then this is to be understood as a dual purpose address (postal and physical). Systems that support importing it like this are encouraged to do so, otherwise they may need to import this as two separate addresses.\r\n\r\nNOTE: FHIR core defines the AD-use extension to further specify the postal address type. However, the ValueSet used in that extension doesn't completely match the HCIM ValueSet. Therefore, a custom extension has been made. This doesn't preclude the use of the AD-use extension.", "comment": "Note: address is for postal addresses, not physical locations.", "requirements": "Need to keep track where the related person can be contacted per postal mail or visited.", "alias": [ "AdresInformatie", "Adresgegevens" ], "min": 0, "max": "*", "base": { "path": "RelatedPerson.address", "min": 0, "max": "*" }, "type": [ { "code": "Address", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-address" ] } ], "example": [ { "label": "Example of a Vacation Home address", "valueAddress": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "HV", "display": "Vakantie adres" } ] } } ], "use": "temp", "line": [ "Binnenkant 12A Hoog" ], "_line": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString": "Binnenkant" }, { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString": "12" }, { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix", "valueString": "A" }, { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID", "valueString": "Hoog" } ] } ], "city": "Amsterdam", "state": "NH", "postalCode": "1000AA", "country": "NLD" } }, { "label": "Example of a Primary Home address", "valueAddress": { "extension": [ { "url": "http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType", "valueCodeableConcept": { "coding": [ { "system": "http://hl7.org/fhir/v3/AddressUse", "code": "HP", "display": "Officieel adres" } ] } }, { "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official", "valueBoolean": true } ], "use": "home", "line": [ "Binnenkant to 10" ], "_line": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName", "valueString": "Binnenkant" }, { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator", "valueString": "to" }, { "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber", "valueString": "10" } ] } ], "city": "Amsterdam", "state": "NH", "postalCode": "1001AA", "country": "NLD" } } ], "condition": [ "ele-1", "nl-streetname-if-official-and-other-line-parts" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "nl-streetname-if-official-and-other-line-parts", "requirements": "This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address", "severity": "error", "human": "Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value", "expression": "(extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not()))", "xpath": "not(.[f:extension[@url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'][f:valueBoolean/@value='true']][f:line[empty(f:extension[@url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'])][f:extension[@url=('http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix','http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator')]]])" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "XAD" }, { "identity": "rim", "map": "AD" }, { "identity": "servd", "map": "Address" }, { "identity": "v2", "map": "NK1-4" }, { "identity": "rim", "map": "addr" }, { "identity": "hcim-address-v2.0.1-2015EN", "map": "NL-CM:0.1.4", "comment": "AddressInformation" }, { "identity": "hcim-addressinformation-v3.0-2016EN", "map": "NL-CM:0.1.4", "comment": "AddressInformation" }, { "identity": "hcim-addressinformation-v1.0-2017EN", "map": "NL-CM:20.5.1", "comment": "AddressInformation" }, { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.5", "comment": "Address" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.5", "comment": "Address" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.5", "comment": "AddressInformation" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.17", "comment": "Address" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.17", "comment": "Address" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.17", "comment": "AddressInformation" } ] }, { "id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "short": "Image of the person", "definition": "Image of the person.", "comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Attachment\".", "requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.photo", "min": 0, "max": "*" }, "type": [ { "code": "Attachment" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "att-1", "severity": "error", "human": "It the Attachment has data, it SHALL have a contentType", "expression": "data.empty() or contentType.exists()", "xpath": "not(exists(f:data)) or exists(f:contentType)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "ED/RP" }, { "identity": "rim", "map": "ED" }, { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc" } ] }, { "id": "RelatedPerson.period", "path": "RelatedPerson.period", "short": "Period of time that this relationship is considered valid", "definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.", "comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "condition": [ "ele-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div" }, { "key": "per-1", "severity": "error", "human": "If present, start SHALL have a lower value than end", "expression": "start.empty() or end.empty() or (start <= end)", "xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)" } ], "mapping": [ { "identity": "rim", "map": "n/a" }, { "identity": "v2", "map": "DR" }, { "identity": "rim", "map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.14", "comment": "DateTime" } ] } ] }, "differential": { "element": [ { "id": "RelatedPerson", "path": "RelatedPerson", "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.1", "comment": "Contact" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.5", "comment": "RelatedPersonAsInformationSource::ContactPerson" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.10", "comment": "RelatedPersonAsAuthor::ContactPerson" }, { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.13", "comment": "RelatedPersonAsSubject::ContactPerson" } ] }, { "id": "RelatedPerson.extension", "path": "RelatedPerson.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "RelatedPerson.extension:role", "path": "RelatedPerson.extension", "sliceName": "role", "short": "Role", "definition": "Defines the role of the contact in relation to the patient.", "alias": [ "Rol" ], "type": [ { "code": "Extension", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson-role" ] } ], "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.2", "comment": "Role" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.2", "comment": "Role" } ] }, { "id": "RelatedPerson.extension:role.valueCodeableConcept:valueCodeableConcept", "path": "RelatedPerson.extension.valueCodeableConcept", "sliceName": "valueCodeableConcept", "binding": { "strength": "extensible" } }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "mapping": [ { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.6", "comment": "IdentificationNumber" } ] }, { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-patient" ] } ], "mapping": [ { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.11", "comment": "Subject" } ] }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "short": "Relationship", "definition": "Defines the contact’s familial relationship to the patient.", "alias": [ "Relatie" ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientRelationshipType" } ], "strength": "extensible" }, "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.3", "comment": "Relationship" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.3", "comment": "Relationship" } ] }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "short": "NameInformation", "definition": "Full name of the contact.", "alias": [ "Naamgegevens" ], "type": [ { "code": "HumanName", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-humanname" ] } ], "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.4", "comment": "Name" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.4", "comment": "Name" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.4", "comment": "NameInformation" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.5", "comment": "PayerName" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.5", "comment": "PayerName" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.5", "comment": "PayerName" } ] }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "short": "ContactInformation", "alias": [ "Contactgegevens" ], "type": [ { "code": "ContactPoint", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-contactpoint" ] } ], "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.6", "comment": "TelephoneE-mail" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.6", "comment": "TelephoneE-mail" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.6", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v2.0.1-2015EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v3.0-2016EN", "map": "NL-CM:0.1.5", "comment": "ContactInformation" }, { "identity": "hcim-contactinformation-v1.0-2017EN", "map": "NL-CM:20.6.4", "comment": "TelephoneNumber" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.12", "comment": "TelephoneE-mail" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.12", "comment": "TelephoneE-mail" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.12", "comment": "ContactInformation" } ] }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "short": "AddressInformation", "alias": [ "Adresgegevens" ], "type": [ { "code": "Address", "profile": [ "http://fhir.nl/fhir/StructureDefinition/nl-core-address" ] } ], "mapping": [ { "identity": "hcim-contactperson-v1.2-2015EN", "map": "NL-CM:3.1.5", "comment": "Address" }, { "identity": "hcim-contactperson-v3.0-2016EN", "map": "NL-CM:3.1.5", "comment": "Address" }, { "identity": "hcim-contactperson-v3.1-2017EN", "map": "NL-CM:3.1.5", "comment": "AddressInformation" }, { "identity": "hcim-payer-v1.2-2015EN", "map": "NL-CM:1.1.17", "comment": "Address" }, { "identity": "hcim-payer-v3.0-2016EN", "map": "NL-CM:1.1.17", "comment": "Address" }, { "identity": "hcim-payer-v3.1-2017EN", "map": "NL-CM:1.1.17", "comment": "AddressInformation" } ] }, { "id": "RelatedPerson.period", "path": "RelatedPerson.period", "mapping": [ { "identity": "hcim-basicelements-v1.0-2017EN", "map": "NL-CM:0.0.14", "comment": "DateTime" } ] } ] } }