1.0.0 - ci-build Norway flag

HelseAPI - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NoHelseAPIPatient

Official URL: http://hl7.no/fhir/StructureDefinition/no-helseapi-Patient Version: 1.0.0
Draft as of 2024-02-09 Computable Name: NoHelseAPIPatient

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NoBasisPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... identifier 1..*IdentifierIdentifier for this patient
... identifier:FNR S0..*IdentifierNorwegian FNR
... identifier:DNR S0..*IdentifierThe D-nummer of the patient
.... extension:middlename S0..1NoBasisMiddlenameDefines a Norwegian middle name
.... family 1..1stringFamily name (often called 'Surname')
.... given 1..*stringGiven names (not always 'first')
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date of birth for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... citizenship N0..*(Complex)The citizenship of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:code N0..1ExtensionNation code of citizenship
Binding: urn:iso:std:iso:3166 (example)
..... extension N0..0
..... url 1..1uri"code"
..... value[x] N1..1CodeableConceptValue of extension
.... extension:period N0..1ExtensionTime period of citizenship
..... extension N0..0
..... url 1..1uri"period"
..... value[x] N1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
.... identifier:FNR SΣ0..*IdentifierNorwegian FNR
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriIdentification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ1..1stringThe actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 13057444850
.... identifier:FHN ΣN0..*IdentifierFelles hjelpenummer used for the patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriIdentification of the Norwegian felles hjelpenummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3
..... value Σ1..1stringThe actual Hjelpenummer
Example General: 123456
.... identifier:DNR SΣ0..*IdentifierThe D-nummer of the patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ1..1stringThe actual D-nummer
Example General: 123456
.... identifier:HNR ΣN0..*IdentifierA locally assigned H-nummer
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner ΣCN1..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..*NoBasisHumanNameNorwegian human name
.... middlename S0..1stringDefines a Norwegian middle name
URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..*stringGiven names (not always 'first')
This repeating element order: Given Names appear in the correct order for presenting the name
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:citizenship.extension:code
[]
example

urn:iso:std:iso:3166

urn:iso:std:iso:3166
Patient.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FHN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:HNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorPatient.identifier:HNR.assigner, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... citizenship N0..*(Complex)The citizenship of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code N0..1ExtensionNation code of citizenship
Binding: urn:iso:std:iso:3166 (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..0
..... url 1..1uri"code"
..... value[x] N1..1CodeableConceptValue of extension
.... extension:period N0..1ExtensionTime period of citizenship
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..0
..... url 1..1uri"period"
..... value[x] N1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ1..*IdentifierIdentifier for this patient
Slice: Unordered, Open by value:system
.... identifier:FNR SΣ0..*IdentifierNorwegian FNR
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriIdentification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ1..1stringThe actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 13057444850
..... period ΣC0..1PeriodTime period when id is/was valid for use
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:FHN ΣN0..*IdentifierFelles hjelpenummer used for the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriIdentification of the Norwegian felles hjelpenummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3
..... value Σ1..1stringThe actual Hjelpenummer
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DNR SΣ0..*IdentifierThe D-nummer of the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ1..1stringThe actual D-nummer
Example General: 123456
..... period ΣC0..1PeriodTime period when id is/was valid for use
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:HNR ΣN0..*IdentifierA locally assigned H-nummer
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣN0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: HNR
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: HNR
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN1..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..*NoBasisHumanNameNorwegian human name
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... middlename S0..1stringDefines a Norwegian middle name
URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..*stringGiven names (not always 'first')
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringPrefix is not used in Norwegian names
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringSuffix is not used in Norwegian human names
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣC0..1PeriodTime period when name was/is in use
... telecom ΣC0..*ContactPointA contact detail for the individual
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*NoBasisAddressNorwegian address
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo C0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1NoBasisHumanNameNorwegian human name
.... telecom C0..*ContactPointA contact detail for the person
.... address 0..1NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period C0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner C0..*Reference(Organization | Practitioner | PractitionerRole | no-basis-Practitioner | no-basis-PractitionerRole | no-basis-Organization)Patient's nominated primary care provider
... managingOrganization ΣC0..1Reference(Organization | no-basis-Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.extension:citizenship.extension:code
[]
example

urn:iso:std:iso:3166

urn:iso:std:iso:3166
Patient.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:FHN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FHN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:DNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:HNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:HNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1errorPatient.identifier:FNR.period, Patient.identifier:FHN.period, Patient.identifier:DNR.period, Patient.identifier:HNR.period, Patient.name.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.identifier:FNR.assigner, Patient.identifier:FHN.assigner, Patient.identifier:DNR.assigner, Patient.identifier:HNR.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from NoBasisPatient

Summary

Mandatory: 4 elements
Must-Support: 5 elements

Differential View

This structure is derived from NoBasisPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... identifier 1..*IdentifierIdentifier for this patient
... identifier:FNR S0..*IdentifierNorwegian FNR
... identifier:DNR S0..*IdentifierThe D-nummer of the patient
.... extension:middlename S0..1NoBasisMiddlenameDefines a Norwegian middle name
.... family 1..1stringFamily name (often called 'Surname')
.... given 1..*stringGiven names (not always 'first')
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date of birth for the individual

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... citizenship N0..*(Complex)The citizenship of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:code N0..1ExtensionNation code of citizenship
Binding: urn:iso:std:iso:3166 (example)
..... extension N0..0
..... url 1..1uri"code"
..... value[x] N1..1CodeableConceptValue of extension
.... extension:period N0..1ExtensionTime period of citizenship
..... extension N0..0
..... url 1..1uri"period"
..... value[x] N1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
.... identifier:FNR SΣ0..*IdentifierNorwegian FNR
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriIdentification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ1..1stringThe actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 13057444850
.... identifier:FHN ΣN0..*IdentifierFelles hjelpenummer used for the patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriIdentification of the Norwegian felles hjelpenummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3
..... value Σ1..1stringThe actual Hjelpenummer
Example General: 123456
.... identifier:DNR SΣ0..*IdentifierThe D-nummer of the patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ1..1stringThe actual D-nummer
Example General: 123456
.... identifier:HNR ΣN0..*IdentifierA locally assigned H-nummer
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner ΣCN1..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..*NoBasisHumanNameNorwegian human name
.... middlename S0..1stringDefines a Norwegian middle name
URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..*stringGiven names (not always 'first')
This repeating element order: Given Names appear in the correct order for presenting the name
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.extension:citizenship.extension:code
[]
example

urn:iso:std:iso:3166

urn:iso:std:iso:3166
Patient.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FHN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:HNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ref-1errorPatient.identifier:HNR.assigner, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*NoBasisPatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... citizenship N0..*(Complex)The citizenship of the patient
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:code N0..1ExtensionNation code of citizenship
Binding: urn:iso:std:iso:3166 (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..0
..... url 1..1uri"code"
..... value[x] N1..1CodeableConceptValue of extension
.... extension:period N0..1ExtensionTime period of citizenship
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..0
..... url 1..1uri"period"
..... value[x] N1..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-citizenship"
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier Σ1..*IdentifierIdentifier for this patient
Slice: Unordered, Open by value:system
.... identifier:FNR SΣ0..*IdentifierNorwegian FNR
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriIdentification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ1..1stringThe actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 13057444850
..... period ΣC0..1PeriodTime period when id is/was valid for use
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:FHN ΣN0..*IdentifierFelles hjelpenummer used for the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriIdentification of the Norwegian felles hjelpenummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.3
..... value Σ1..1stringThe actual Hjelpenummer
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DNR SΣ0..*IdentifierThe D-nummer of the patient
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ1..1stringThe actual D-nummer
Example General: 123456
..... period ΣC0..1PeriodTime period when id is/was valid for use
..... assigner ΣC0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:HNR ΣN0..*IdentifierA locally assigned H-nummer
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type ΣN0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣN0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.578.1.12.4.1.1.8327
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: HNR
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Fixed Value: HNR
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period ΣCN0..1PeriodTime period when id is/was valid for use
..... assigner ΣCN1..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..*NoBasisHumanNameNorwegian human name
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... middlename S0..1stringDefines a Norwegian middle name
URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..*stringGiven names (not always 'first')
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringPrefix is not used in Norwegian names
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringSuffix is not used in Norwegian human names
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣC0..1PeriodTime period when name was/is in use
... telecom ΣC0..*ContactPointA contact detail for the individual
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*NoBasisAddressNorwegian address
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo C0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1NoBasisHumanNameNorwegian human name
.... telecom C0..*ContactPointA contact detail for the person
.... address 0..1NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period C0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner C0..*Reference(Organization | Practitioner | PractitionerRole | no-basis-Practitioner | no-basis-PractitionerRole | no-basis-Organization)Patient's nominated primary care provider
... managingOrganization ΣC0..1Reference(Organization | no-basis-Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.extension:citizenship.extension:code
[]
example

urn:iso:std:iso:3166

urn:iso:std:iso:3166
Patient.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:FHN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:FHN.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:DNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:HNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:HNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
att-1errorPatient.photoIf the Attachment has data, it SHALL have a contentType
: data.empty() or contentType.exists()
cpt-2errorPatient.telecom, Patient.contact.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1errorPatient.identifier:FNR.period, Patient.identifier:FHN.period, Patient.identifier:DNR.period, Patient.identifier:HNR.period, Patient.name.period, Patient.contact.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorPatient.identifier:FNR.assigner, Patient.identifier:FHN.assigner, Patient.identifier:DNR.assigner, Patient.identifier:HNR.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.otherSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from NoBasisPatient

Summary

Mandatory: 4 elements
Must-Support: 5 elements

 

Other representations of profile: CSV, Excel, Schematron