{
"description": null,
"_filename": "NLLPatient.StructureDefinition.json",
"package_name": "bonsai.demo.a",
"date": "2023-06-12",
"derivation": "constraint",
"publisher": "Swedish eHealth Agency",
"fhirVersion": "4.0.1",
"name": "NLLPatient",
"mapping": [ {
"name": "E-hälsomyndigheten concept",
"identity": "EHM"
} ],
"abstract": false,
"type": "Patient",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "2.2.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "Patient",
"min": 0,
"definition": "Administrative information, such as name and identification number, about an individual which may exists as a patient in the Swedish National Medications List",
"isModifier": false,
"short": "Information about an individual as a patient in the Swedish National Medications List",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Patient[classCode=PAT]",
"identity": "rim"
}, {
"map": "ClinicalDocument.recordTarget.patientRole",
"identity": "cda"
}, {
"map": "Patient",
"identity": "EHM"
} ],
"alias": [ "SubjectOfCare Client Resident" ],
"max": "*",
"id": "Patient",
"base": {
"max": "*",
"min": 0,
"path": "Patient"
},
"isSummary": false
}, {
"path": "Patient.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"mapping": [ {
"map": "Patient-id",
"identity": "EHM"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"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": "Patient.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Patient.meta.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": "Patient.meta.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": "Patient.meta.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": "Patient.meta.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": "Patient.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"isModifier": false,
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Patient.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"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": "Patient.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"isModifier": false,
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http.html#read) interaction.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"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": "Patient.meta.source",
"min": 0,
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"isModifier": false,
"short": "Identifies where the resource comes from",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.meta.source",
"comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.source"
},
"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": "Patient.meta.profile",
"min": 0,
"definition": "A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).",
"isModifier": false,
"short": "Profiles this resource claims to conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"max": "*",
"id": "Patient.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"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": "Patient.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"isModifier": false,
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "Patient.meta.security",
"comment": "Security labels are used for two purposes in this resourse.\r\nThe SUBSETTED label indicates that the resource is an incomplete representation of the information in the Swedish Population Registry.\r\nThe PROTECTIDENT label indicates that the person's record is marked with an protected identity label of some kind in the Swedish Population Registry.\r\nThe DEMO label work in tandem with the PROTECTIDENT flag.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "Patient.meta.security.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": "Patient.meta.security.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": "Patient.meta.security.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": "Patient.meta.security.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": "Patient.meta.security.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.meta.security.system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.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": "Patient.meta.security.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.meta.security.version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"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": "Patient.meta.security.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.meta.security.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"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": "Patient.meta.security.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.meta.security.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"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": "Patient.meta.security.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.meta.security.userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"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": "Patient.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"isModifier": false,
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"."
},
"max": "*",
"id": "Patient.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"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": "Patient.implicitRules",
"min": 0,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.implicitRules",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"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": "Patient.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "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
} ],
"description": "A human language."
},
"max": "1",
"id": "Patient.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"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": "Patient.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can 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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Patient.text",
"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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "Patient.contained",
"min": 0,
"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.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Patient.contained",
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"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": "Patient.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.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": "DomainResource.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())"
}, {
"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": "Patient.extension",
"min": 0,
"definition": "Describes whether the patient is registered in the Swedish Population Register (sv folkbokförd) or not.\r\nCalculated by the Swedish eHealth Agency.",
"isModifier": true,
"short": "Population Registered",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "n/a",
"identity": "rim"
}, {
"map": "Folkbokförd",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLPopulationRegistered" ]
} ],
"mustSupport": true,
"sliceName": "nllPopulationRegistered",
"meaningWhenMissing": "A missing value shall be interpreted as UNKNOWN",
"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"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/population-registered-status"
},
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Patient.extension:nllPopulationRegistered",
"condition": [ "ele-1" ],
"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": "DomainResource.extension"
},
"isModifierReason": "Verified or unverified information",
"isSummary": false
}, {
"path": "Patient.extension.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": "Patient.extension:nllPopulationRegistered.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": "Patient.extension.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": "Patient.extension:nllPopulationRegistered.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
}, {
"path": "Patient.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://electronichealth.se/fhir/StructureDefinition/NLLPopulationRegistered",
"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": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.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.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"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": "Patient.extension.value[x]",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
}, {
"path": "Patient.extension.value[x].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": "Patient.extension:nllPopulationRegistered.value[x].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": "Patient.extension.value[x].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": "Patient.extension:nllPopulationRegistered.value[x].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": "Patient.extension.value[x].system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"isModifier": false,
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x].system",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.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": "Patient.extension.value[x].version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"isModifier": false,
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x].version",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"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": "Patient.extension.value[x].code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"isModifier": false,
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x].code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"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": "Patient.extension.value[x].display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"isModifier": false,
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x].display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"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": "Patient.extension.value[x].userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"isModifier": false,
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.extension:nllPopulationRegistered.value[x].userSelected",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"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())"
}, {
"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": "Patient.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.modifierExtension",
"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": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"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": "Patient.identifier",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 0,
"definition": "A national identification number. The only supported type of identification is currently Swedish personal identity number.",
"isModifier": false,
"short": "An identifier for this patient",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": ".id",
"identity": "cda"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Patient.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Patient.identifier"
},
"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": "Patient.identifier",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 0,
"definition": "Swedish personal identity number (sv: personnummer)",
"isModifier": false,
"short": "Swedish personal identity number",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": ".id",
"identity": "cda"
}, {
"map": "Personnummer",
"identity": "EHM"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"sliceName": "pnr",
"max": "1",
"id": "Patient.identifier:pnr",
"base": {
"max": "*",
"min": 0,
"path": "Patient.identifier"
},
"isSummary": true
}, {
"path": "Patient.identifier.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": "Patient.identifier:pnr.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": "Patient.identifier.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": "Patient.identifier:pnr.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": "Patient.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary | old (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known ."
},
"max": "1",
"id": "Patient.identifier:pnr.use",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a 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": "Patient.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"isModifier": false,
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."
},
"max": "1",
"id": "Patient.identifier:pnr.type",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"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": "Patient.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"isModifier": false,
"short": "The namespace for the identifier value",
"fixedUri": "http://electronichealth.se/identifier/personnummer",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.identifier:pnr.system",
"comment": "Identifier.system is always case sensitive.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.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())"
}, {
"key": "swe-id-rule",
"human": "A personal identity number must have 12 digits",
"source": "Patient",
"severity": "error",
"expression": "$this.matches('^\\\\d{12}$')"
} ],
"path": "Patient.identifier.value",
"min": 1,
"definition": "Swedish personal identity number expressed as 12 digits without hyphen.",
"isModifier": false,
"short": "Swedish personal identity number",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.identifier:pnr.value",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"maxLength": 12,
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.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": "Patient.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"isModifier": false,
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.identifier:pnr.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"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": "Patient.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"isModifier": false,
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "Patient.identifier:pnr.assigner",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"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": "Patient.active",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
"min": 0,
"definition": "Whether this patient record is in active use. \nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.",
"isModifier": true,
"short": "Whether this patient's record is in active use",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "statusCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "Aktiv",
"identity": "EHM"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": true,
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
"max": "1",
"id": "Patient.active",
"comment": "If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.active"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
"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": "Patient.name",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min": 0,
"definition": "A name associated with the individual.",
"isModifier": false,
"short": "A name associated with the patient",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": ".patient.name",
"identity": "cda"
} ],
"type": [ {
"code": "HumanName"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.name",
"comment": "A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.name"
},
"isSummary": true
}, {
"path": "Patient.name.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": "Patient.name.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": "Patient.name.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": "Patient.name.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": "Patient.name.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"definition": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"mapping": [ {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
} ],
"description": "The use of a human name."
},
"max": "1",
"id": "Patient.name.use",
"comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name 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": "Patient.name.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "Specifies the entire name as it should be displayed. This may be provided instead of or as well as the specific parts. Maximum length 36 characters if the patient is from FOLK and 60 characters if the patient is not from FOLK.",
"isModifier": false,
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "Redigerat namn",
"comment": "Patient finns i FOLK",
"identity": "EHM"
}, {
"map": "Fullständigt namn",
"comment": "Patient saknas i FOLK",
"identity": "EHM"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.name.text",
"comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"maxLength": 60,
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"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": "Patient.name.family",
"min": 0,
"definition": "In the scenario that the name has been fetched from the Population Register (sv: folkbokföring) the maximum string length for the family name is 100.\r\nIn the scenario that the patient's name is provided by an external system (when a patient does not have a personal identity number) the maxmimun string length for family name is 35.",
"isModifier": false,
"short": "Family name (often called 'Surname')",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
}, {
"map": "Efternamn",
"identity": "EHM"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "surname" ],
"max": "1",
"id": "Patient.name.family",
"comment": "Middle name has different definitions in the Swedish Population Registry and FHIR. The middle name in the population registry is seen from an FHIR context as an additional family name. This is mapped as middle name + space + family name (eg \"Johansson Svensson\") when this resource represents a person in the populatoin registry.",
"maxLength": 100,
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"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": "Patient.name.given",
"min": 0,
"definition": "In the scenario that the name has been fetched from the Population Register (sv: folkbokföring) there can be multiple given names. Total maxmimun string length for all given names are 80.\r\nIn the scenario that the patient's name is provided by an external system (when a patient does not have a personal identity number) only one (1) given name is allowed. Maxmimun string length for that given name is 35.",
"isModifier": false,
"short": "Given names",
"mapping": [ {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
}, {
"map": "Förnamn",
"identity": "EHM"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "first name", "middle name" ],
"max": "*",
"id": "Patient.name.given",
"comment": "Middle name has different definitions in the Swedish Population Registry and FHIR. The middle name in the population registry is seen from an FHIR context as an additional family name. The \"call me\" name in a list of multiple given names (first name + middle names in FHIR) is marked with CL by the extension nllNameQualifier.",
"maxLength": 80,
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"path": "Patient.name.given.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references)",
"isModifier": false,
"short": "xml:id (or equivalent in JSON)",
"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": "Patient.name.given.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": "Patient.name.given.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.given.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())"
}, {
"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": "Patient.name.given.extension",
"min": 0,
"definition": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to describe \"tilltalsnamn\".",
"isModifier": false,
"short": "CL (call me)",
"mapping": [ {
"map": "ENXP.qualifier",
"identity": "rim"
}, {
"map": "Tilltalsnamnsmarkering",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" ]
} ],
"mustSupport": true,
"sliceName": "nllNameQualifier",
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/name-part-qualifier"
},
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.given.extension:nllNameQualifier",
"condition": [ "ele-1" ],
"comment": "Used to indicate additional information about the name part and how it should be used.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Patient.name.given.value",
"min": 0,
"definition": "The actual value",
"isModifier": false,
"short": "Primitive value for string",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.given.value",
"maxLength": 1048576,
"base": {
"max": "1",
"min": 0,
"path": "string.value"
},
"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": "Patient.name.prefix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"isModifier": false,
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.prefix",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"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": "Patient.name.suffix",
"min": 0,
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"isModifier": false,
"short": "Parts that come after the name",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.suffix",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"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": "Patient.name.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"isModifier": false,
"short": "Time period when name was/is in use",
"mapping": [ {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.name.period",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"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": "Patient.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"isModifier": false,
"short": "A contact detail for the individual",
"mapping": [ {
"map": "PID-13, PID-14, PID-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": ".telecom",
"identity": "cda"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Patient.telecom",
"comment": "A Patient 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. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"base": {
"max": "*",
"min": 0,
"path": "Patient.telecom"
},
"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": "Patient.gender",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date.",
"min": 0,
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Used only when personal identity number is missing.",
"isModifier": false,
"short": "male | female | unknown",
"mapping": [ {
"map": "PID-8",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": ".patient.administrativeGenderCode",
"identity": "cda"
}, {
"map": "Kön",
"comment": "Only used when the patient doesn't have a personal identity number",
"identity": "EHM"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/administrative-gender",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes."
},
"max": "1",
"id": "Patient.gender",
"comment": "The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.gender"
},
"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": "Patient.birthDate",
"requirements": "Age of the individual drives many clinical processes.",
"min": 0,
"definition": "The date of birth for the individual. Used only when personal identity number is missing.",
"isModifier": false,
"short": "The date of birth for the individual",
"mapping": [ {
"map": "PID-7",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime",
"identity": "rim"
}, {
"map": ".patient.birthTime",
"identity": "cda"
}, {
"map": "21112-8",
"identity": "loinc"
}, {
"map": "Födelsedatum",
"comment": "Only used in cases where the patient doesn't have/use the national identification number.",
"identity": "EHM"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.birthDate",
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.birthDate"
},
"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": "Patient.deceased[x]",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min": 0,
"definition": "Indicates if the individual is deceased or not. This flag is in the Swedish National Mediations List a translation from status 4 (sv: Person avliden) in FOLK.",
"isModifier": true,
"short": "Indicates if the individual is deceased or not",
"mapping": [ {
"map": "PID-30 (bool) and PID-29 (datetime)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "Avliden",
"identity": "EHM"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": true,
"meaningWhenMissing": "Person is not deceased",
"max": "1",
"id": "Patient.deceased[x]",
"comment": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased, should be interpreted that patient is NOT deceased.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.deceased[x]"
},
"isModifierReason": "This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
"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": "Patient.address",
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"definition": "The Swedish National Medications List only returns a municipality code (sv kommunkod) and a region code (sv läns-/regionkod)",
"isModifier": false,
"short": "An address for the individual",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
}, {
"map": ".addr",
"identity": "cda"
}, {
"map": "Personadress",
"identity": "EHM"
} ],
"type": [ {
"code": "Address"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.address",
"comment": "Patient may have multiple addresses with different uses or applicable periods.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.address"
},
"isSummary": true
}, {
"path": "Patient.address.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": "Patient.address.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": "Patient.address.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": "Patient.address.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())"
}, {
"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": "Patient.address.extension",
"min": 0,
"definition": "Municipality code, also called Official Municipality Key (sv: kommunkod) are four letter numeric codes which identfies a municipality (sv: kommun) in Sweden. Codes are decided by SCB.\r\nExample: Kalmar 0880",
"isModifier": false,
"short": "Municipality code (sv. kommunkod)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Kommun",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLMunicipalityCode" ]
} ],
"mustSupport": true,
"sliceName": "nllMunicipalityCode",
"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"
} ],
"binding": {
"strength": "required",
"valueSet": "http://scb.se",
"description": "Statistics in Sweden (SCB)"
},
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Patient.address.extension:nllMunicipalityCode",
"condition": [ "ele-1" ],
"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())"
}, {
"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": "Patient.address.extension",
"min": 0,
"definition": "Region code is a two letter numeric code for regions (sv: region/län) in Sweden",
"isModifier": false,
"short": "Region code (sv: region/länskod)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Län",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLRegionCode" ]
} ],
"mustSupport": true,
"sliceName": "nllRegionCode",
"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"
} ],
"binding": {
"strength": "required",
"valueSet": "http://scb.se",
"description": "Statistics in Sweden (SCB)"
},
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Patient.address.extension:nllRegionCode",
"condition": [ "ele-1" ],
"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": "Patient.address.use",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.",
"isModifier": true,
"short": "home | work | temp | old | billing - purpose of this address",
"mapping": [ {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-use|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address."
},
"max": "1",
"id": "Patient.address.use",
"comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address 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": "Patient.address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"isModifier": false,
"short": "postal | physical | both",
"mapping": [ {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/address-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)."
},
"max": "1",
"id": "Patient.address.type",
"comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](location.html#) resource).",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"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": "Patient.address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"isModifier": false,
"short": "Text representation of the address",
"mapping": [ {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.address.text",
"comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"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": "Patient.address.line",
"min": 0,
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"isModifier": false,
"short": "Street name, number, direction & P.O. Box etc.",
"mapping": [ {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.address.line",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"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": "Patient.address.city",
"min": 0,
"definition": "The name of the city, town, suburb, village or other community or delivery center.",
"isModifier": false,
"short": "Name of city, town etc.",
"mapping": [ {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Municpality" ],
"max": "1",
"id": "Patient.address.city",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"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": "Patient.address.district",
"min": 0,
"definition": "The name of the administrative area (county).",
"isModifier": false,
"short": "District name (aka county)",
"mapping": [ {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County" ],
"max": "1",
"id": "Patient.address.district",
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"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": "Patient.address.state",
"min": 0,
"definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"isModifier": false,
"short": "Sub-unit of country (abbreviations ok)",
"mapping": [ {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Province", "Territory" ],
"max": "1",
"id": "Patient.address.state",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"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": "Patient.address.postalCode",
"min": 0,
"definition": "A postal code designating a region defined by the postal service.",
"isModifier": false,
"short": "Postal code for area",
"mapping": [ {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Zip" ],
"max": "1",
"id": "Patient.address.postalCode",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"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": "Patient.address.country",
"min": 0,
"definition": "Country - a nation as commonly understood or generally accepted.",
"isModifier": false,
"short": "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"mapping": [ {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.address.country",
"comment": "ISO 3166 3 letter codes can be used in place of a human readable country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"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": "Patient.address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"isModifier": false,
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.address.period",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01",
"start": "2010-03-23"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"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": "Patient.maritalStatus",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"definition": "This field contains a patient's most recent marital (civil) status.",
"isModifier": false,
"short": "Marital (civil) status of a patient",
"mapping": [ {
"map": "PID-16",
"identity": "v2"
}, {
"map": "player[classCode=PSN]/maritalStatusCode",
"identity": "rim"
}, {
"map": ".patient.maritalStatusCode",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/marital-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MaritalStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The domestic partnership status of a person."
},
"max": "1",
"id": "Patient.maritalStatus",
"base": {
"max": "1",
"min": 0,
"path": "Patient.maritalStatus"
},
"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": "Patient.multipleBirth[x]",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min": 0,
"definition": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).",
"isModifier": false,
"short": "Whether patient is part of a multiple birth",
"mapping": [ {
"map": "PID-24 (bool), PID-25 (integer)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
} ],
"max": "1",
"id": "Patient.multipleBirth[x]",
"comment": "Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.multipleBirth[x]"
},
"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": "Patient.photo",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the patient.",
"isModifier": false,
"short": "Image of the patient",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "Patient.photo",
"comment": "Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.photo"
},
"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": "pat-1",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)",
"severity": "error",
"expression": "name.exists() or telecom.exists() or address.exists() or organization.exists()"
} ],
"path": "Patient.contact",
"requirements": "Need to track people you can contact about the patient.",
"min": 0,
"definition": "A contact party (e.g. guardian, partner, friend) for the patient.",
"isModifier": false,
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"mapping": [ {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Contact"
} ],
"max": "*",
"id": "Patient.contact",
"comment": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact"
},
"isSummary": false
}, {
"path": "Patient.contact.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": "Patient.contact.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": "Patient.contact.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"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.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())"
}, {
"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": "Patient.contact.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.contact.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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": "Patient.contact.relationship",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"definition": "The nature of the relationship between the patient and the contact person.",
"isModifier": false,
"short": "The kind of relationship",
"mapping": [ {
"map": "NK1-7, NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/patient-contactrelationship",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactRelationship"
} ],
"description": "The nature of the relationship between a patient and a contact person for that patient."
},
"max": "*",
"id": "Patient.contact.relationship",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.relationship"
},
"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": "Patient.contact.name",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min": 0,
"definition": "A name associated with the contact person.",
"isModifier": false,
"short": "A name associated with the contact person",
"mapping": [ {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "HumanName"
} ],
"max": "1",
"id": "Patient.contact.name",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.name"
},
"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": "Patient.contact.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"isModifier": false,
"short": "A contact detail for the person",
"mapping": [ {
"map": "NK1-5, NK1-6, NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Patient.contact.telecom",
"comment": "Contact 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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.telecom"
},
"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": "Patient.contact.address",
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min": 0,
"definition": "Address for the contact person.",
"isModifier": false,
"short": "Address for the contact person",
"mapping": [ {
"map": "NK1-4",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Address"
} ],
"max": "1",
"id": "Patient.contact.address",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.address"
},
"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": "Patient.contact.gender",
"requirements": "Needed to address the person correctly.",
"min": 0,
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"isModifier": false,
"short": "male | female | other | unknown",
"mapping": [ {
"map": "NK1-15",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes."
},
"max": "1",
"id": "Patient.contact.gender",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.gender"
},
"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": "Patient.contact.organization",
"requirements": "For guardians or business related contacts, the organization is relevant.",
"min": 0,
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
"isModifier": false,
"short": "Organization that is associated with the contact",
"mapping": [ {
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41",
"identity": "v2"
}, {
"map": "scoper",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "Patient.contact.organization",
"condition": [ "pat-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.organization"
},
"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": "Patient.contact.period",
"min": 0,
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"isModifier": false,
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"mapping": [ {
"map": "effectiveTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.contact.period",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.period"
},
"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": "Patient.communication",
"requirements": "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.",
"min": 0,
"definition": "A language which may be used to communicate with the patient about his or her health.",
"isModifier": false,
"short": "A language which may be used to communicate with the patient about his or her health",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
}, {
"map": "patient.languageCommunication",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Patient.communication",
"comment": "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.communication"
},
"isSummary": false
}, {
"path": "Patient.communication.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": "Patient.communication.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": "Patient.communication.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"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.communication.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())"
}, {
"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": "Patient.communication.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.communication.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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": "Patient.communication.language",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"isModifier": false,
"short": "The language which can be used to communicate with the patient about his or her health",
"mapping": [ {
"map": "PID-15, LAN-2",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
}, {
"map": ".languageCode",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "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
} ],
"description": "A human language."
},
"max": "1",
"id": "Patient.communication.language",
"comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.communication.language"
},
"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": "Patient.communication.preferred",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min": 0,
"definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"isModifier": false,
"short": "Language preference indicator",
"mapping": [ {
"map": "PID-15",
"identity": "v2"
}, {
"map": "preferenceInd",
"identity": "rim"
}, {
"map": ".preferenceInd",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.communication.preferred"
},
"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": "Patient.generalPractitioner",
"min": 0,
"definition": "Patient's nominated care provider.",
"isModifier": false,
"short": "Patient's nominated primary care provider",
"mapping": [ {
"map": "PD1-4",
"identity": "v2"
}, {
"map": "subjectOf.CareEvent.performer.AssignedEntity",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"alias": [ "careProvider" ],
"max": "*",
"id": "Patient.generalPractitioner",
"comment": "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.generalPractitioner"
},
"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": "Patient.managingOrganization",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"definition": "Organization that is the custodian of the patient record.",
"isModifier": false,
"short": "Organization that is the custodian of the patient record",
"mapping": [ {
"map": "scoper",
"identity": "rim"
}, {
"map": ".providerOrganization",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "Patient.managingOrganization",
"comment": "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.managingOrganization"
},
"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": "Patient.link",
"requirements": "There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.",
"min": 0,
"definition": "Link to another patient resource that concerns the same actual patient.",
"isModifier": true,
"short": "Link to another patient resource that concerns the same actual person",
"mapping": [ {
"map": "outboundLink",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Patient.link",
"comment": "There is no assumption that linked patient records have mutual links.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.link"
},
"isModifierReason": "This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'",
"isSummary": true
}, {
"path": "Patient.link.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": "Patient.link.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": "Patient.link.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"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.link.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())"
}, {
"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": "Patient.link.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.link.modifierExtension",
"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": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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": "Patient.link.other",
"min": 1,
"definition": "The other patient resource that the link refers to.",
"isModifier": false,
"short": "The other patient or related person resource that the link refers to",
"mapping": [ {
"map": "PID-3, MRG-1",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
"valueBoolean": false
} ],
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"max": "1",
"id": "Patient.link.other",
"comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.other"
},
"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": "Patient.link.type",
"min": 1,
"definition": "The type of link between this patient resource and another patient resource.",
"isModifier": false,
"short": "replaced-by | replaces | refer | seealso",
"mapping": [ {
"map": "typeCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/link-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LinkType"
} ],
"description": "The type of link between this patient resource and another patient resource."
},
"max": "1",
"id": "Patient.link.type",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.type"
},
"isSummary": true
} ]
},
"status": "active",
"id": "89e33ebe-4281-4b58-9a0e-4b13d45b2417",
"kind": "resource",
"url": "http://electronichealth.se/fhir/StructureDefinition/NLLPatient",
"version": "1.0.2",
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient",
"short": "Information about an individual as a patient in the Swedish National Medications List",
"mapping": [ {
"map": "Patient",
"identity": "EHM"
} ],
"definition": "Administrative information, such as name and identification number, about an individual which may exists as a patient in the Swedish National Medications List"
}, {
"id": "Patient.id",
"path": "Patient.id",
"mapping": [ {
"map": "Patient-id",
"identity": "EHM"
} ],
"mustSupport": true
}, {
"id": "Patient.meta",
"path": "Patient.meta",
"mustSupport": true
}, {
"id": "Patient.meta.lastUpdated",
"path": "Patient.meta.lastUpdated",
"mustSupport": true
}, {
"id": "Patient.meta.security",
"path": "Patient.meta.security",
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels"
},
"comment": "Security labels are used for two purposes in this resourse.\r\nThe SUBSETTED label indicates that the resource is an incomplete representation of the information in the Swedish Population Registry.\r\nThe PROTECTIDENT label indicates that the person's record is marked with an protected identity label of some kind in the Swedish Population Registry.\r\nThe DEMO label work in tandem with the PROTECTIDENT flag.",
"mustSupport": true
}, {
"id": "Patient.meta.security.system",
"path": "Patient.meta.security.system",
"mustSupport": true
}, {
"id": "Patient.meta.security.version",
"path": "Patient.meta.security.version",
"mustSupport": true
}, {
"id": "Patient.meta.security.code",
"path": "Patient.meta.security.code",
"mustSupport": true
}, {
"path": "Patient.extension",
"mapping": [ {
"map": "Folkbokförd",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLPopulationRegistered" ]
} ],
"mustSupport": true,
"sliceName": "nllPopulationRegistered",
"meaningWhenMissing": "A missing value shall be interpreted as UNKNOWN",
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/population-registered-status"
},
"max": "1",
"id": "Patient.extension:nllPopulationRegistered"
}, {
"id": "Patient.extension:nllPopulationRegistered.value[x]",
"path": "Patient.extension.value[x]"
}, {
"id": "Patient.extension:nllPopulationRegistered.value[x].system",
"path": "Patient.extension.value[x].system",
"mustSupport": true
}, {
"id": "Patient.extension:nllPopulationRegistered.value[x].version",
"path": "Patient.extension.value[x].version",
"mustSupport": true
}, {
"id": "Patient.extension:nllPopulationRegistered.value[x].code",
"path": "Patient.extension.value[x].code",
"mustSupport": true
}, {
"id": "Patient.identifier",
"path": "Patient.identifier",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"definition": "A national identification number. The only supported type of identification is currently Swedish personal identity number.",
"mustSupport": true
}, {
"id": "Patient.identifier:pnr",
"max": "1",
"path": "Patient.identifier",
"short": "Swedish personal identity number",
"mapping": [ {
"map": "Personnummer",
"identity": "EHM"
} ],
"sliceName": "pnr",
"definition": "Swedish personal identity number (sv: personnummer)",
"mustSupport": true
}, {
"id": "Patient.identifier:pnr.system",
"min": 1,
"path": "Patient.identifier.system",
"fixedUri": "http://electronichealth.se/identifier/personnummer",
"mustSupport": true
}, {
"id": "Patient.identifier:pnr.value",
"min": 1,
"path": "Patient.identifier.value",
"short": "Swedish personal identity number",
"maxLength": 12,
"constraint": [ {
"key": "swe-id-rule",
"human": "A personal identity number must have 12 digits",
"source": "Patient",
"severity": "error",
"expression": "$this.matches('^\\\\d{12}$')"
} ],
"definition": "Swedish personal identity number expressed as 12 digits without hyphen.",
"mustSupport": true
}, {
"id": "Patient.active",
"path": "Patient.active",
"mapping": [ {
"map": "Aktiv",
"identity": "EHM"
} ],
"mustSupport": true
}, {
"id": "Patient.name",
"max": "1",
"path": "Patient.name",
"mustSupport": true
}, {
"id": "Patient.name.text",
"path": "Patient.name.text",
"mapping": [ {
"map": "Redigerat namn",
"comment": "Patient finns i FOLK",
"identity": "EHM"
}, {
"map": "Fullständigt namn",
"comment": "Patient saknas i FOLK",
"identity": "EHM"
} ],
"maxLength": 60,
"definition": "Specifies the entire name as it should be displayed. This may be provided instead of or as well as the specific parts. Maximum length 36 characters if the patient is from FOLK and 60 characters if the patient is not from FOLK.",
"mustSupport": true
}, {
"id": "Patient.name.family",
"path": "Patient.name.family",
"comment": "Middle name has different definitions in the Swedish Population Registry and FHIR. The middle name in the population registry is seen from an FHIR context as an additional family name. This is mapped as middle name + space + family name (eg \"Johansson Svensson\") when this resource represents a person in the populatoin registry.",
"mapping": [ {
"map": "Efternamn",
"identity": "EHM"
} ],
"maxLength": 100,
"definition": "In the scenario that the name has been fetched from the Population Register (sv: folkbokföring) the maximum string length for the family name is 100.\r\nIn the scenario that the patient's name is provided by an external system (when a patient does not have a personal identity number) the maxmimun string length for family name is 35.",
"mustSupport": true
}, {
"id": "Patient.name.given",
"path": "Patient.name.given",
"short": "Given names",
"comment": "Middle name has different definitions in the Swedish Population Registry and FHIR. The middle name in the population registry is seen from an FHIR context as an additional family name. The \"call me\" name in a list of multiple given names (first name + middle names in FHIR) is marked with CL by the extension nllNameQualifier.",
"mapping": [ {
"map": "Förnamn",
"identity": "EHM"
} ],
"maxLength": 80,
"definition": "In the scenario that the name has been fetched from the Population Register (sv: folkbokföring) there can be multiple given names. Total maxmimun string length for all given names are 80.\r\nIn the scenario that the patient's name is provided by an external system (when a patient does not have a personal identity number) only one (1) given name is allowed. Maxmimun string length for that given name is 35.",
"mustSupport": true
}, {
"path": "Patient.name.given.extension",
"definition": "A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type. Used to describe \"tilltalsnamn\".",
"short": "CL (call me)",
"mapping": [ {
"map": "Tilltalsnamnsmarkering",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" ]
} ],
"mustSupport": true,
"sliceName": "nllNameQualifier",
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/name-part-qualifier"
},
"id": "Patient.name.given.extension:nllNameQualifier"
}, {
"id": "Patient.gender",
"path": "Patient.gender",
"short": "male | female | unknown",
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/administrative-gender"
},
"mapping": [ {
"map": "Kön",
"comment": "Only used when the patient doesn't have a personal identity number",
"identity": "EHM"
} ],
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Used only when personal identity number is missing.",
"mustSupport": true
}, {
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"mapping": [ {
"map": "Födelsedatum",
"comment": "Only used in cases where the patient doesn't have/use the national identification number.",
"identity": "EHM"
} ],
"definition": "The date of birth for the individual. Used only when personal identity number is missing.",
"mustSupport": true
}, {
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"type": [ {
"code": "boolean"
} ],
"comment": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased, should be interpreted that patient is NOT deceased.",
"mapping": [ {
"map": "Avliden",
"identity": "EHM"
} ],
"definition": "Indicates if the individual is deceased or not. This flag is in the Swedish National Mediations List a translation from status 4 (sv: Person avliden) in FOLK.",
"mustSupport": true,
"meaningWhenMissing": "Person is not deceased"
}, {
"id": "Patient.address",
"max": "1",
"path": "Patient.address",
"mapping": [ {
"map": "Personadress",
"identity": "EHM"
} ],
"definition": "The Swedish National Medications List only returns a municipality code (sv kommunkod) and a region code (sv läns-/regionkod)",
"mustSupport": true
}, {
"path": "Patient.address.extension",
"definition": "Municipality code, also called Official Municipality Key (sv: kommunkod) are four letter numeric codes which identfies a municipality (sv: kommun) in Sweden. Codes are decided by SCB.\r\nExample: Kalmar 0880",
"short": "Municipality code (sv. kommunkod)",
"mapping": [ {
"map": "Kommun",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLMunicipalityCode" ]
} ],
"mustSupport": true,
"sliceName": "nllMunicipalityCode",
"binding": {
"strength": "required",
"valueSet": "http://scb.se",
"description": "Statistics in Sweden (SCB)"
},
"id": "Patient.address.extension:nllMunicipalityCode"
}, {
"path": "Patient.address.extension",
"definition": "Region code is a two letter numeric code for regions (sv: region/län) in Sweden",
"short": "Region code (sv: region/länskod)",
"mapping": [ {
"map": "Län",
"identity": "EHM"
} ],
"type": [ {
"code": "Extension",
"profile": [ "http://electronichealth.se/fhir/StructureDefinition/NLLRegionCode" ]
} ],
"mustSupport": true,
"sliceName": "nllRegionCode",
"binding": {
"strength": "required",
"valueSet": "http://scb.se",
"description": "Statistics in Sweden (SCB)"
},
"id": "Patient.address.extension:nllRegionCode"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}