2.2.0-test - ci-build Norway flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: no-basis-RelatedPerson

Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-RelatedPerson Version: 2.2.0-test
Active as of 2019-05-20 Computable Name: NoBasisRelatedPerson

Basisprofil for Norwegian RelatedPerson information. Defined by The Norwegian Directorate of eHealth and HL7 Norway. Should be used as a basis for further profiling in use-cases where specific identity information is needed. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.

Typical use-case for no-basis-RelatedPerson involves information about relations person-patient.

  • Relations registered in norwegian Master Person Information Index (aka Folkeregisteret)
  • Other relationship information registered on a patient or person neccessary for patient treatment
  • Should not be used for contact persons for the patient with a predefined role in the patient care, as information as this is registered separately in the Patient resource

Usage:

Formal Views of Profile Content

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

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPerson
... Slices for identifier 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR 0..* Identifier Norwegian FNR
..... system 1..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value 1..1 string The actual Fødselsnummer
Example Fødselsnummer: 15076500565
.... identifier:DNR 0..* Identifier The D-nummer of the patient
..... system 1..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value 1..1 string The actual D-nummer
Example D-nummer: 700199 50032
... patient 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
.... relationship:maritalStatus 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status
.... relationship:familyRelation 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation
.... relationship:parental 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility
... address 0..* NoBasisAddress Norwegian address

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR Σ 0..* Identifier Norwegian FNR
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ 1..1 string The actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 15076500565
.... identifier:DNR Σ 0..* Identifier The D-nummer of the patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ 1..1 string The actual D-nummer
Example General: 123456
Example D-nummer: 700199 50032
... patient Σ 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


.... relationship:maritalStatus Σ 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
.... relationship:familyRelation Σ 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
.... relationship:parental Σ 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
... name 0..* NoBasisHumanName Norwegian human name
... address 0..* NoBasisAddress Norwegian address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR Σ 0..* Identifier Norwegian FNR
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ 1..1 string The actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 15076500565
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:DNR Σ 0..* Identifier The D-nummer of the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ 1..1 string The actual D-nummer
Example General: 123456
Example D-nummer: 700199 50032
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


.... relationship:maritalStatus Σ 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... relationship:familyRelation Σ 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... relationship:parental Σ 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... name 0..* NoBasisHumanName Norwegian human name
... telecom Σ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address 0..* NoBasisAddress Norwegian address
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:FNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:DNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element(7 nested mandatory elements)
Fixed: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier
  • The element 1 is sliced based on the value of RelatedPerson.relationship

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson RelatedPerson
... Slices for identifier 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR 0..* Identifier Norwegian FNR
..... system 1..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value 1..1 string The actual Fødselsnummer
Example Fødselsnummer: 15076500565
.... identifier:DNR 0..* Identifier The D-nummer of the patient
..... system 1..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value 1..1 string The actual D-nummer
Example D-nummer: 700199 50032
... patient 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
.... relationship:maritalStatus 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status
.... relationship:familyRelation 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation
.... relationship:parental 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility
... address 0..* NoBasisAddress Norwegian address

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR Σ 0..* Identifier Norwegian FNR
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ 1..1 string The actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 15076500565
.... identifier:DNR Σ 0..* Identifier The D-nummer of the patient
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ 1..1 string The actual D-nummer
Example General: 123456
Example D-nummer: 700199 50032
... patient Σ 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


.... relationship:maritalStatus Σ 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
.... relationship:familyRelation Σ 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
.... relationship:parental Σ 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
... name 0..* NoBasisHumanName Norwegian human name
... address 0..* NoBasisAddress Norwegian address

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
.... identifier:FNR Σ 0..* Identifier Norwegian FNR
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri Identification of the Norwegian FNR
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.1
..... value Σ 1..1 string The actual Fødselsnummer
Example General: 123456
Example Fødselsnummer: 15076500565
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:DNR Σ 0..* Identifier The D-nummer of the patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description 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..1 uri The identification of the D-nummer
Fixed Value: urn:oid:2.16.578.1.12.4.1.4.2
..... value Σ 1..1 string The actual D-nummer
Example General: 123456
Example D-nummer: 700199 50032
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient | no-basis-Patient) The person this person is related to
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:coding.system
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


.... relationship:maritalStatus Σ 0..* CodeableConcept marital status from Norwegian Person Index
Binding: no-basis-marital-status.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... relationship:familyRelation Σ 0..* CodeableConcept Family relationship from Norwegian Person Index
Binding: no-basis-family-relation.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... relationship:parental Σ 0..* CodeableConcept Parental responsibility registered in Norwegian person index
Binding: no-basis-parental-responsibility.valueset (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... name 0..* NoBasisHumanName Norwegian human name
... telecom Σ 0..* ContactPoint A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the related person was born
... address 0..* NoBasisAddress Norwegian address
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
RelatedPerson.identifier:FNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:FNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.identifier:DNR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
RelatedPerson.identifier:DNR.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
RelatedPerson.relationshippreferredPatientRelationshipType
http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
from the FHIR Standard
RelatedPerson.relationship:maritalStatusrequiredNoBasisMaritalStatus (a valid code from no-basis-marital-status.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-marital-status
from this IG
RelatedPerson.relationship:familyRelationrequiredNoBasisFamilyRelation (a valid code from no-basis-family-relation.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-family-relation
from this IG
RelatedPerson.relationship:parentalrequiredNoBasisParentalResponsibility (a valid code from no-basis-parental-responsibility.codesystem)
http://hl7.no/fhir/ValueSet/no-basis-parental-responsibility
from this IG
RelatedPerson.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceRelatedPersonA 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()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element(7 nested mandatory elements)
Fixed: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of RelatedPerson.identifier
  • The element 1 is sliced based on the value of RelatedPerson.relationship

 

Other representations of profile: CSV, Excel, Schematron