FHIR IG Statistics: StructureDefinition/NLLPatient.StructureDefinition
Resources that use this resource
Resources that this resource uses
Narrative
No narrative content found in resource
Source
{
"resourceType": "StructureDefinition",
"url": "http://electronichealth.se/fhir/StructureDefinition/NLLPatient",
"version": "1.1.2",
"name": "NLLPatient",
"status": "active",
"date": "2023-06-12",
"publisher": "Swedish eHealth Agency",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "EHM",
"name": "E-hälsomyndigheten concept"
}
],
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Patient",
"path": "Patient",
"short": "Information about an individual as a patient in the Swedish National Medications List",
"definition": "Administrative information, such as name and identification number, about an individual which may exists as a patient in the Swedish National Medications List",
"mapping": [
{
"identity": "EHM",
"map": "Patient"
}
]
},
{
"id": "Patient.id",
"path": "Patient.id",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Patient-id"
}
]
},
{
"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",
"comment": "TEST DEV. 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,
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/security-labels"
}
},
{
"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
},
{
"id": "Patient.extension:nllPopulationRegistered",
"path": "Patient.extension",
"sliceName": "nllPopulationRegistered",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/StructureDefinition/NLLPopulationRegistered"
]
}
],
"meaningWhenMissing": "A missing value shall be interpreted as UNKNOWN",
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://ehalsomyndigheten.se/fhir/ValueSet/population-registered-status"
},
"mapping": [
{
"identity": "EHM",
"map": "Folkbokförd"
}
]
},
{
"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": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"rules": "open"
},
"definition": "A national identification number. The only supported type of identification is currently Swedish personal identity number.",
"mustSupport": true
},
{
"id": "Patient.identifier:pnr",
"path": "Patient.identifier",
"sliceName": "pnr",
"short": "Swedish personal identity number",
"definition": "Swedish personal identity number (sv: personnummer)",
"max": "1",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Personnummer"
}
]
},
{
"id": "Patient.identifier:pnr.system",
"path": "Patient.identifier.system",
"min": 1,
"fixedUri": "http://electronichealth.se/identifier/personnummer",
"mustSupport": true
},
{
"id": "Patient.identifier:pnr.value",
"path": "Patient.identifier.value",
"short": "Swedish personal identity number",
"definition": "Swedish personal identity number expressed as 12 digits without hyphen.",
"min": 1,
"maxLength": 12,
"constraint": [
{
"key": "swe-id-rule",
"severity": "error",
"human": "A personal identity number must have 12 digits",
"expression": "$this.matches('^\\\\d{12}[%content%]#39;)",
"source": "Patient"
}
],
"mustSupport": true
},
{
"id": "Patient.active",
"path": "Patient.active",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Aktiv"
}
]
},
{
"id": "Patient.name",
"path": "Patient.name",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.name.text",
"path": "Patient.name.text",
"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.",
"maxLength": 60,
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Redigerat namn",
"comment": "Patient finns i FOLK"
},
{
"identity": "EHM",
"map": "Fullständigt namn",
"comment": "Patient saknas i FOLK"
}
]
},
{
"id": "Patient.name.family",
"path": "Patient.name.family",
"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.",
"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,
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Efternamn"
}
]
},
{
"id": "Patient.name.given",
"path": "Patient.name.given",
"short": "Given names",
"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.",
"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,
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Förnamn"
}
]
},
{
"id": "Patient.name.given.extension:nllNameQualifier",
"path": "Patient.name.given.extension",
"sliceName": "nllNameQualifier",
"short": "CL (call me)",
"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\".",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/name-part-qualifier"
},
"mapping": [
{
"identity": "EHM",
"map": "Tilltalsnamnsmarkering"
}
]
},
{
"id": "Patient.gender",
"path": "Patient.gender",
"short": "male | female | unknown",
"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,
"binding": {
"strength": "required",
"valueSet": "http://electronichealth.se/fhir/ValueSet/administrative-gender"
},
"mapping": [
{
"identity": "EHM",
"map": "Kön",
"comment": "Only used when the patient doesn't have a personal identity number"
}
]
},
{
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"definition": "The date of birth for the individual. Used only when personal identity number is missing.",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Födelsedatum",
"comment": "Only used in cases where the patient doesn't have/use the national identification number."
}
]
},
{
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"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.",
"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.",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "Person is not deceased",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Avliden"
}
]
},
{
"id": "Patient.address",
"path": "Patient.address",
"definition": "The Swedish National Medications List only returns a municipality code (sv kommunkod) and a region code (sv läns-/regionkod)",
"max": "1",
"mustSupport": true,
"mapping": [
{
"identity": "EHM",
"map": "Personadress"
}
]
},
{
"id": "Patient.address.extension:nllMunicipalityCode",
"path": "Patient.address.extension",
"sliceName": "nllMunicipalityCode",
"short": "Municipality code (sv. kommunkod)",
"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",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/StructureDefinition/NLLMunicipalityCode"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Statistics in Sweden (SCB)",
"valueSet": "http://scb.se"
},
"mapping": [
{
"identity": "EHM",
"map": "Kommun"
}
]
},
{
"id": "Patient.address.extension:nllRegionCode",
"path": "Patient.address.extension",
"sliceName": "nllRegionCode",
"short": "Region code (sv: region/länskod)",
"definition": "Region code is a two letter numeric code for regions (sv: region/län) in Sweden",
"type": [
{
"code": "Extension",
"profile": [
"http://electronichealth.se/fhir/StructureDefinition/NLLRegionCode"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Statistics in Sweden (SCB)",
"valueSet": "http://scb.se"
},
"mapping": [
{
"identity": "EHM",
"map": "Län"
}
]
}
]
}
}
FHIR