{
"description": "The GdPerson profile describes the structure and coding of demographic data concerning a norwegian citizen or person with other legal relation with the kingdom of Norway. At this time the information is collected from FREG and presented through a FHIR RESTful interface from the Person information service.\\r\\n\\r\\nFolkeregisterperson fra FREG.",
"_filename": "gd-Person.StructureDefinition-profile.json",
"package_name": "ehelse.fhir.no.grunndata",
"date": "2019-12-11",
"derivation": "constraint",
"publisher": "Direktoratet for e-helse",
"fhirVersion": "4.0.1",
"name": "GdPerson",
"abstract": false,
"type": "Person",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "2.3.5-buildnumbersuffix2",
"status": "draft",
"id": "ccf2d1ed-1eef-44b4-8f22-04a6fc215686",
"kind": "resource",
"url": "http://ehelse.no/fhir/StructureDefinition/gd-Person",
"version": "3.0.0",
"differential": {
"element": [ {
"id": "Person.meta",
"path": "Person.meta",
"definition": "THIS ELEMENT IS MANDATORY.\r\n The support of the Person.meta.security element is considered MANDATORY by all systems implementing access to the Person-API. \r\n The element is returned by default from the responder service. \r\n All requestor systems SHALL be able to display the information in the data element for human use meaning; any user given access to the information throug the system or subsystems should be able to interpret this information in a meaningfull way. Requestors SHALL be able to process and store the information. \r\n Some information made available by the service has special security and legal obligations and must be handled according to the relevant legislation. Any failure to support these requirements could lead to the harm or death of the Person whom the information concerns.",
"mustSupport": true
}, {
"id": "Person.meta.security",
"path": "Person.meta.security",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"mustSupport": true
}, {
"path": "Person.meta.security",
"definition": "informasjon om gradering av adresseinformasjon for personer iht. Beskyttelsesinstruksen eller Folkeregisterloven\r\n\r\nInformasjonen benyttes til å beskrive det overordnede felles beskyttelsesnivået en person har på alle sine adresser av typen bostedsadresse, oppholdsadresse og delt bosted. Adressebeskyttelsen gjelder ikke kontaktadressene.",
"short": "address confidentiality from FREG",
"type": [ {
"code": "Coding",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-coding-security" ]
} ],
"mustSupport": true,
"sliceName": "addressConfidentiality",
"binding": {
"strength": "required",
"valueSet": "http://ehelse.no/fhir/ValueSet/gd-person-addressprotection",
"description": "Security labels from FREG"
},
"alias": [ "adressebeskyttelse", "graderingsnivå" ],
"id": "Person.meta.security:addressConfidentiality"
}, {
"id": "Person.meta.security:addressConfidentiality.system",
"min": 1,
"path": "Person.meta.security.system",
"fixedUri": "http://ehelse.no/fhir/CodeSystem/gd-address-confidentiality"
}, {
"id": "Person.meta.security:addressConfidentiality.code",
"min": 1,
"path": "Person.meta.security.code",
"alias": [ "graderingsnivå" ],
"short": "graderingsnivå from FREG",
"definition": "nivå av beskyttelsesgrad på informasjon\r\nGyldige kodeverdier er:\r\n• ugradert\r\n• fortrolig\r\n• strengtFortrolig (strengt fortrolig)"
}, {
"id": "Person.implicitRules",
"path": "Person.implicitRules",
"mustSupport": false
}, {
"id": "Person.language",
"path": "Person.language",
"mustSupport": false
}, {
"id": "Person.text",
"path": "Person.text",
"mustSupport": false
}, {
"id": "Person.contained",
"path": "Person.contained",
"mustSupport": false
}, {
"id": "Person.extension",
"path": "Person.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Person.extension:deceased",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-deceased" ]
} ],
"alias": [ "Dødsfall" ],
"sliceName": "deceased",
"mustSupport": true
}, {
"id": "Person.extension:birth",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-birth" ]
} ],
"alias": [ "Fødsel" ],
"sliceName": "birth",
"mustSupport": true
}, {
"id": "Person.extension:birth.extension",
"path": "Person.extension.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Person.extension:birth.extension:birthYear",
"path": "Person.extension.extension",
"sliceName": "birthYear",
"definition": "The birth year for the person registered in FREG. \r\n\r\nFREG always exposes a birthYear that can be found in this element. When the brithDate is known this information will exist in addition to the information about the birthYear of the person."
}, {
"id": "Person.extension:birthInNorway",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-birth-in-norway" ]
} ],
"sliceName": "birthInNorway",
"mustSupport": true
}, {
"id": "Person.extension:migration",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-migration" ]
} ],
"short": "Migration information from FREG about a Person",
"sliceName": "migration",
"definition": "Migration information from FREG about a Person\r\n\r\nutflytting/emigration\r\ninformasjon om hvilket land og sted i dette landet en utflyttet person bor eller bodde etter utflyttingen fra Norge\r\nUtflytting, enten som følge av at en person selv melder om utflytting fra Norge eller som følge av at det foreligger annen informasjon som tilsier at en person har flyttet ut fra Norge, for eksempel fra annet nordisk folkeregister eller fra UDI. Utenlandske statsborgere som ikke lenger har adgang til å oppholde seg i Norge regnes som utflyttet, jf. folkeregisterforskriften § 4-7 nr 1 annet ledd. UDI sender melding til Folkeregisteret når en person har utgått oppholdstillatelse, tilbakekalt oppholdstillatelse eller statsborgerskap, bortfalt oppholdstillatelse eller er utvist fra Norge. Se for øvrig dokumentasjon av status utflyttet 5.2.1\r\n\r\ninnflytting/immigration\r\ninformasjon om hvilket land og sted i dette landet en innflyttet person bodde før innflyttingen til Norge\r\nInnflytting omfatter registrering i Folkeregisteret av personer som enten skal tildeles fødselsnummer fordi de skal bosettes, eller d-nummer fordi de regnes for å ha en midlertidig tilknytning til Norge.\r\nGyldighetsdatoen settes til vedtaksdato for godkjent innflytting fra Utlendingsmyndigheten.",
"mustSupport": true
}, {
"id": "Person.extension:citizenship",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-person-citizenship" ]
} ],
"sliceName": "citizenship",
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension",
"path": "Person.extension.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Person.extension:citizenship.extension:code",
"path": "Person.extension.extension",
"sliceName": "code",
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension:code.value[x].coding.system",
"path": "Person.extension.extension.value[x].coding.system",
"definition": "Grunndata - sets the system value of http://hl7.org/fhir/ValueSet/iso3166-1-3 or extension for the extended code values from FREG\r\n\r\nThe identification of the code system that defines the meaning of the symbol in the code.",
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension:code.value[x].coding.code",
"path": "Person.extension.extension.value[x].coding.code",
"alias": [ "Kode for statsborgerskap" ],
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension:period",
"path": "Person.extension.extension",
"sliceName": "period",
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension:period.value[x].start",
"path": "Person.extension.extension.value[x].start",
"mustSupport": true
}, {
"id": "Person.extension:citizenship.extension:fregMetadata",
"path": "Person.extension.extension",
"sliceName": "fregMetadata",
"mustSupport": true
}, {
"id": "Person.extension:fregPersonStatus",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-person-status" ]
} ],
"sliceName": "fregPersonStatus",
"mustSupport": true
}, {
"id": "Person.extension:residencePermit",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-residence-permit" ]
} ],
"short": "Information registered in FREG regarding the residence permit of the person.",
"sliceName": "residencePermit",
"definition": "Information registered in FREG regarding the residence permit of the person.\r\n\r\nInformasjonen innen opphold beskriver opplysninger i Registeret som omfatter oppholdstillatelse, oppholdsrett og arbeidstillatelse.",
"mustSupport": true
}, {
"id": "Person.extension:citizenshipRetention",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-person-citizenship-retention" ]
} ],
"sliceName": "citizenshipRetention",
"definition": "Status and date of Norwegian citizenship for persons with multiple citizenships.",
"mustSupport": true
}, {
"id": "Person.extension:fakeIdentity",
"max": "1",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fake-identity" ]
} ],
"sliceName": "fakeIdentity",
"mustSupport": true,
"meaningWhenMissing": "When fakeIdentity is missing from the resource the Person resource, the information describes an actual person. Only a fregIsFake value of \"true\" means the Person information describes a known fake identity."
}, {
"id": "Person.extension:identityControlStatus",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-identity-control" ]
} ],
"sliceName": "identityControlStatus",
"mustSupport": true
}, {
"id": "Person.extension:identityDocument",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-identity-document" ]
} ],
"sliceName": "identityDocument",
"mustSupport": true
}, {
"id": "Person.extension:residueContact",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-residue-contact" ]
} ],
"sliceName": "residueContact",
"mustSupport": true
}, {
"id": "Person.extension:residueContact.extension",
"path": "Person.extension.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Person.extension:residueContact.extension:fregMetadata",
"path": "Person.extension.extension",
"sliceName": "fregMetadata",
"mustSupport": true
}, {
"id": "Person.extension:samiLanguage",
"path": "Person.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-sami-language" ]
} ],
"sliceName": "samiLanguage",
"mustSupport": true
}, {
"id": "Person.identifier",
"min": 1,
"path": "Person.identifier",
"slicing": {
"rules": "closed",
"description": "Sliced by value:system (FNR/DNR) or type.system (foreign Identifier)"
},
"mustSupport": true
}, {
"id": "Person.identifier:FNR",
"path": "Person.identifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Identifier-freg" ]
} ],
"sliceName": "FNR",
"mustSupport": true
}, {
"id": "Person.identifier:DNR",
"path": "Person.identifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Identifier-freg" ]
} ],
"sliceName": "DNR",
"mustSupport": true
}, {
"id": "Person.identifier:foreignIdentifier",
"path": "Person.identifier",
"type": [ {
"code": "Identifier",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Identifier-foreign" ]
} ],
"sliceName": "foreignIdentifier",
"definition": "Identification number from foreign authority or the identifier value from the Norwegian immigration administration.\r\nForeign identifiers from FREG is discriminated by the identifierType value. FREG uses two different elements for this information:\r\n- utenlandsk personidentifikasjon: informasjon om et personidentifikasjonsnummer fra en utenlandsk myndighet\r\n- utlendingsmyndighetenes identifikasjonsnummer: personidentifikasjonsnummer for person som blir førstegangsregistrert i landet av utlendingsmyndighetene. Dette nummeret går i dag ofte under navnet DUF-nummer",
"mustSupport": true
}, {
"id": "Person.identifier:foreignIdentifier.system",
"path": "Person.identifier.system",
"fixedUri": "http://ehelse.no/fhir/CodeSystem/gd-person-identificationnumbertype"
}, {
"id": "Person.name",
"path": "Person.name",
"type": [ {
"code": "HumanName",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-HumanName" ]
} ],
"definition": "navn på person som består av fornavn og ett enkelt eller dobbelt etternavn og kan i tillegg bestå av mellomnavn\r\n\r\ngd-HumanName Contains information and metadata for human names defined in Norwegian Master Person Index and Norwegian Directorate of e-Health's health related Master Person Index.
Defines the format of norwegian human name according to norwegian regulation (lov om personnavn).",
"mustSupport": true
}, {
"id": "Person.gender",
"path": "Person.gender",
"alias": [ "kjønn", "personkjønn" ],
"short": "Juridical gender of the person male | female",
"binding": {
"strength": "required",
"valueSet": "http://ehelse.no/fhir/ValueSet/gd-person-gender"
},
"definition": "The juridical gender of the person. Only codes for male and female is used by FREG (mann/kvinne). Includes FREG metadata. Gender history must be collected via Hendelser as no more than one gender is supported by the base FHIR Resource.\r\n\r\nBeskrivelse fra kilden FREG\r\ndet kjønnet en person er registrert med i Folkeregisteret\r\nDette er et nytt eget informasjonsfelt i Folkeregisteret siden det kun var en del av informasjonen i fødsels- eller d-nummeret i DSF.\r\nInformasjonen gir det «juridiske kjønn» som personen har fått eller selv har valgt.\r\nMulige verdier etter Folkeregisterloven:\r\n• mann\r\n• kvinne\r\nUnder migrering vil kjønn settes ut fra kodingen av kjønn som del av fødsels- eller d-nummer (3. siffer i personnummeret som partall gir kvinne.)\r\nNår kjønn er migrert til Registeret vil kjønn kunne endres separat i Freg.\r\n\r\n\r\nAdministrative Gender.",
"mustSupport": true
}, {
"id": "Person.gender.extension",
"path": "Person.gender.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Person.gender.extension:metadata",
"max": "1",
"path": "Person.gender.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata" ]
} ],
"short": "Metadata about gender from FREG",
"sliceName": "metadata",
"definition": "Metadata about gender from FREG"
}, {
"id": "Person.birthDate",
"path": "Person.birthDate",
"alias": [ "fødselsdato" ],
"definition": "The birth date for the person registered in FREG. FREG always exposes a birthYear that can be found in the gd-birth extension: Person.extension:birthYear\r\n\r\nWhen the brithDate is known this information will exist in addition to the information about the birthYear found in the gd-birth extension.\r\n\r\nThe metadata about the birtDate from FREG is always connected to the gd-birth extension: Person.extension:birth\r\nFREG can expose more than one birthDate of any given person but the FHIR model only allows one recorded birthDate\r\n\r\ndatoen en person er født\r\n\r\nI det gamle DSF hadde vi ikke eget felt for fødselsdato. Fødselsdatoen (riktig, fastsatt eller fiktiv) fremkommer kun av fødselsnummer/d-nummer. Dette betyr at når vi ikke har ubrukte tilgjengelige fødselsnumre/d-numre for en spesifikk fødselsdato (\"presset dato\") så settes en fiktiv fødselsdato i fødselsnummeret/d-nummeret. Den reelle fødselsdatoen er dermed ikke tilgjengelig i DSF.",
"mustSupport": true
}, {
"id": "Person.address",
"path": "Person.address",
"type": [ {
"code": "Address",
"profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Address-cadastral", "http://ehelse.no/fhir/StructureDefinition/gd-Address-international", "http://ehelse.no/fhir/StructureDefinition/gd-Address-street", "http://ehelse.no/fhir/StructureDefinition/gd-Address-box", "http://ehelse.no/fhir/StructureDefinition/gd-Address-freeform", "http://ehelse.no/fhir/StructureDefinition/gd-Address-unknown" ]
} ],
"definition": "Grunndata uses Five different address content types expressed in gd-Address profiles that further restricts the use of the http://hl7.no/fhir/StructureDefinition/no-basis-Address to contain information from the norwegian Master person index.\r\n\r\nBased on: http://hl7.no/fhir/StructureDefinition/no-basis-Address",
"mustSupport": true
}, {
"id": "Person.photo",
"path": "Person.photo",
"mustSupport": false
}, {
"id": "Person.managingOrganization",
"path": "Person.managingOrganization",
"mustSupport": false
}, {
"id": "Person.active",
"path": "Person.active",
"mapping": [ {
"map": "n/a",
"comment": "There are no direct mapping of this concept to FREG",
"identity": "freg"
} ],
"definition": "Gd-Person use this element to describe active and not active Person-resources. There are currently different cases that translates into active=false:\r\n\r\n* fregPersonStatus= opphørt\r\n* In some special cases where two Person documents are merged into one\r\n* In some special cases where a Person document is nullified because it was registered in error\r\n\r\nA person instances can become not-active in special cases where two person instances is appended into one. In this case one Person instance remains active (active=true) while the duplicate is considered not-active (active=false).\r\n\r\nPerson instances with value active=false is not returned from the service unless a specific search is made for instances containing the active=false value.\r\n\r\nWhether this person's record is in active use.",
"mustSupport": true
}, {
"id": "Person.link",
"path": "Person.link",
"mustSupport": false
} ]
},
"baseDefinition": "http://hl7.no/fhir/StructureDefinition/no-basis-Person"
}