DIPS Core Implementation Guide
0.1.0 - ci-build
Norway
DIPS Core Implementation Guide
0.1.0 - ci-build
Norway
DIPS Core Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://dips.no/fhir/R4/StructureDefinition/DIPSRelatedPerson | Version: 0.1.0 | |||
| Draft as of 2026-11-10 | Computable Name: DIPSRelatedPerson | |||
The DIPS Related Person Profile inherits from the FHIR Related Person resource; refer to it for scope and usage definitions
Example Usage Scenarios:
The following are example usage scenarios for this profile:
Query by Related Person name or NPI
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  RelatedPerson |
0..* | NoBasisRelatedPerson | 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 | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |
 extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |
  extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
 url |
1..1 | uri | "http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality" | |
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |
 extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |
 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 (no extensions allowed) | |
| 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 (no extensions allowed) | |
| value |
1..1 | string | The actual D-nummer Example General: 123456 Example D-nummer: 700199 50032 | |
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
 identifier:relativeId |
0..* | Identifier | A human identifier for this person | |
 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| active |
0..1 | boolean | Whether this related person's record is in active use | |
 patient |
1..1 | DIPSBasisPatientR4Reference(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) | |
| relationship:relativeType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:caringFunction |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:guardian |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:relationshipType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:dipsRelation |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.identifier:FNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:maritalStatus | Base | required | no-basis-marital-status.valueset | 📦2.0.12 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:familyRelation | Base | required | no-basis-family-relation.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:parental | Base | required | no-basis-parental-responsibility.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:relativeType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:caringFunction | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:guardian | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:relationshipType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:dipsRelation | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from NoBasisRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
0..* | NoBasisRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |
| extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |
  value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://dips.no/fhir/R4/StructureDefinition/DIPSRelatedPersonAppointedByMunicipality (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |
| extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique | |
| identifier:relativeId |
0..* | Identifier | A human identifier for this person | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique | |
| active |
0..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | DIPSBasisPatientR4Reference(Patient | no-basis-Patient) | The person this person is related to | |
| Slices for relationship |
Content/Rules for all slices | |||
| relationship:relativeType |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.1045 (no extensions allowed) | |
| relationship:caringFunction |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.4353 (no extensions allowed) | |
| relationship:guardian |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.3508 (no extensions allowed) | |
| relationship:relationshipType |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (no extensions allowed) | |
| relationship:dipsRelation |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.3210 (no extensions allowed) | |
| name |
||||
| text |
0..1 | string | Text representation of the full name | |
| family |
0..1 | string | Family name (often called 'Surname') | |
| given |
0..* | string | Given names (not always 'first') | |
| gender |
0..1 | code | male | female | other | unknown | |
| birthDate |
0..1 | date | The date on which the related person was born | |
| address |
||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | Poststed or city | |
| district |
0..1 | string | name of "kommune" | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:municipalityCode |
0..* | Coding | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/MunicipalityCode | |
| state |
0..1 | string | norwegian "fylke" | |
| postalCode |
0..1 | string | Postal code for area | |
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| period |
||||
| start |
0..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| photo |
0..0 | Image of the person | ||
| communication |
0..0 | A language which may be used to communicate with about the patient's health | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | NoBasisRelatedPerson | 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |||||
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |||||
| extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality" | |||||
| value[x] |
0..1 | Coding | Value of extension | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://dips.no/fhir/R4/StructureDefinition/DIPSRelatedPersonAppointedByMunicipality (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |||||
| extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |||||
| 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 (no extensions allowed) | |||||
| 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 (no extensions allowed) | |||||
| 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) | |||||
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |||||
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| 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:relativeId |
0..* | Identifier | A human identifier for this person | |||||
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| 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 | DIPSBasisPatientR4Reference(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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status (no extensions allowed) | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation (no extensions allowed) | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility (no extensions allowed) | |||||
| 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:relativeType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.1045 (no extensions allowed) | |||||
| 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:caringFunction |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.4353 (no extensions allowed) | |||||
| 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:guardian |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.3508 (no extensions allowed) | |||||
| 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:relationshipType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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.org/fhir/ValueSet/relatedperson-relationshiptype (no extensions allowed) | |||||
| 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:dipsRelation |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.3210 (no extensions allowed) | |||||
| 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 | A name associated with the person | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:middlename |
0..1 | string | Defines a middle name URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename | |||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
| text |
0..1 | string | Text representation of the full name | |||||
| family |
0..1 | string | Family name (often called 'Surname') | |||||
| given |
0..* | string | Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name | |||||
| prefix |
0..* | string | Prefix is not used in Norwegian names This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
| suffix |
0..* | string | Suffix is not used in Norwegian human names This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
| period |
0..1 | Period | Time period when name was/is in use | |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:official |
0..1 | boolean | The concept of an officially registered address URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official | |||||
| extension:urbanDistrict |
0..1 | Coding | urban district information URL: http://hl7.no/fhir/StructureDefinition/no-basis-urban-district Binding: urn:oid:2.16.578.1.12.4.1.1.3403 (required): Bydel | |||||
| extension:propertyInformation |
0..* | (Complex) | Real property identification URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation | |||||
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||
| city |
0..1 | string | Poststed or city Example General: Erewhon | |||||
| district |
0..1 | string | name of "kommune" Example General: Madison | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:municipalitycode |
0..1 | Coding | Coded value for municipality/county Norwegian kommune URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required) | |||||
| extension:municipalityCode |
0..* | Coding | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/MunicipalityCode | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| state |
0..1 | string | norwegian "fylke" | |||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:FNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:FNR.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:maritalStatus | Base | required | no-basis-marital-status.valueset | 📦2.0.12 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:familyRelation | Base | required | no-basis-family-relation.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:parental | Base | required | no-basis-parental-responsibility.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:relativeType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:caringFunction | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:guardian | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:relationshipType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:dipsRelation | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from NoBasisRelatedPerson
Summary
Mandatory: 0 element(9 nested mandatory elements)
Fixed: 8 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
0..* | NoBasisRelatedPerson | 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 | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |
| extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality" | |
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |
| extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |
| 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 (no extensions allowed) | |
| 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 (no extensions allowed) | |
| value |
1..1 | string | The actual D-nummer Example General: 123456 Example D-nummer: 700199 50032 | |
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:relativeId |
0..* | Identifier | A human identifier for this person | |
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| active |
0..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | DIPSBasisPatientR4Reference(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) | |
| relationship:relativeType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:caringFunction |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:guardian |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:relationshipType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |
| relationship:dipsRelation |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.identifier:FNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:maritalStatus | Base | required | no-basis-marital-status.valueset | 📦2.0.12 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:familyRelation | Base | required | no-basis-family-relation.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:parental | Base | required | no-basis-parental-responsibility.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:relativeType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:caringFunction | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:guardian | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:relationshipType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:dipsRelation | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from NoBasisRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| RelatedPerson |
0..* | NoBasisRelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |
| extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://dips.no/fhir/R4/StructureDefinition/DIPSRelatedPersonAppointedByMunicipality (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |
| extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique | |
| identifier:relativeId |
0..* | Identifier | A human identifier for this person | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |
| value |
1..1 | string | The value that is unique | |
| active |
0..1 | boolean | Whether this related person's record is in active use | |
| patient |
1..1 | DIPSBasisPatientR4Reference(Patient | no-basis-Patient) | The person this person is related to | |
| Slices for relationship |
Content/Rules for all slices | |||
| relationship:relativeType |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.1045 (no extensions allowed) | |
| relationship:caringFunction |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.4353 (no extensions allowed) | |
| relationship:guardian |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.3508 (no extensions allowed) | |
| relationship:relationshipType |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype (no extensions allowed) | |
| relationship:dipsRelation |
0..* | CodeableConcept | The nature of the relationship | |
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: urn:oid:1.3.6.1.4.1.9038.52.3210 (no extensions allowed) | |
| name |
||||
| text |
0..1 | string | Text representation of the full name | |
| family |
0..1 | string | Family name (often called 'Surname') | |
| given |
0..* | string | Given names (not always 'first') | |
| gender |
0..1 | code | male | female | other | unknown | |
| birthDate |
0..1 | date | The date on which the related person was born | |
| address |
||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. | |
| city |
0..1 | string | Poststed or city | |
| district |
0..1 | string | name of "kommune" | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:municipalityCode |
0..* | Coding | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/MunicipalityCode | |
| state |
0..1 | string | norwegian "fylke" | |
| postalCode |
0..1 | string | Postal code for area | |
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
| period |
||||
| start |
0..1 | dateTime | Starting time with inclusive boundary | |
| end |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
| photo |
0..0 | Image of the person | ||
| communication |
0..0 | A language which may be used to communicate with about the patient's health | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | NoBasisRelatedPerson | 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:kinship |
0..* | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonKinship | |||||
| extension:parentalResponsibility |
0..* | boolean | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonParentalResponsibility | |||||
| extension:appointedByMunicipality |
0..1 | (Complex) | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAppointedByMunicipality" | |||||
| value[x] |
0..1 | Coding | Value of extension | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://dips.no/fhir/R4/StructureDefinition/DIPSRelatedPersonAppointedByMunicipality (no extensions allowed) | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| extension:responsibleRequisitioner |
0..1 | Reference() | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonResponsibleRequisitioner | |||||
| extension:additionalInformation |
0..1 | string | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/DIPSRelatedPersonAdditionalInformation | |||||
| 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 (no extensions allowed) | |||||
| 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 (no extensions allowed) | |||||
| 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) | |||||
| identifier:guardianId |
0..* | Identifier | A human identifier for this person | |||||
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-guardianid (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| 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:relativeId |
0..* | Identifier | A human identifier for this person | |||||
| 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 namespace for the identifier value Fixed Value: http://dips.no/fhir/namingsystem/dips-relativeid (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| 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 | DIPSBasisPatientR4Reference(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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-marital-status (no extensions allowed) | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-family-relation (no extensions allowed) | |||||
| 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 |
0..1 | uri | Identity of the terminology system Fixed Value: http://hl7.no/fhir/CodeSystem/no-basis-parental-responsibility (no extensions allowed) | |||||
| 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:relativeType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.1045 (no extensions allowed) | |||||
| 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:caringFunction |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.4353 (no extensions allowed) | |||||
| 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:guardian |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.3508 (no extensions allowed) | |||||
| 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:relationshipType |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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.org/fhir/ValueSet/relatedperson-relationshiptype (no extensions allowed) | |||||
| 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:dipsRelation |
0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | |||||
| 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: urn:oid:1.3.6.1.4.1.9038.52.3210 (no extensions allowed) | |||||
| 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 | A name associated with the person | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:middlename |
0..1 | string | Defines a middle name URL: http://hl7.no/fhir/StructureDefinition/no-basis-middlename | |||||
| use |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||
| text |
0..1 | string | Text representation of the full name | |||||
| family |
0..1 | string | Family name (often called 'Surname') | |||||
| given |
0..* | string | Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name | |||||
| prefix |
0..* | string | Prefix is not used in Norwegian names This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
| suffix |
0..* | string | Suffix is not used in Norwegian human names This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
| period |
0..1 | Period | Time period when name was/is in use | |||||
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:official |
0..1 | boolean | The concept of an officially registered address URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official | |||||
| extension:urbanDistrict |
0..1 | Coding | urban district information URL: http://hl7.no/fhir/StructureDefinition/no-basis-urban-district Binding: urn:oid:2.16.578.1.12.4.1.1.3403 (required): Bydel | |||||
| extension:propertyInformation |
0..* | (Complex) | Real property identification URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation | |||||
| use |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
| type |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
| text |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
| line |
0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | |||||
| city |
0..1 | string | Poststed or city Example General: Erewhon | |||||
| district |
0..1 | string | name of "kommune" Example General: Madison | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:municipalitycode |
0..1 | Coding | Coded value for municipality/county Norwegian kommune URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required) | |||||
| extension:municipalityCode |
0..* | Coding | Optional Extensions Element URL: http://dips.no/fhir/StructureDefinition/R4/MunicipalityCode | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| state |
0..1 | string | norwegian "fylke" | |||||
| postalCode |
0..1 | string | Postal code for area Example General: 9132 | |||||
| country |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||
| period |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:FNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:FNR.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:DNR.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:guardianId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.identifier:relativeId.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:maritalStatus | Base | required | no-basis-marital-status.valueset | 📦2.0.12 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:familyRelation | Base | required | no-basis-family-relation.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:parental | Base | required | no-basis-parental-responsibility.valueset | 📦2.0.8 | hl7.fhir.no.basis v2.2 |
| RelatedPerson.relationship:relativeType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:caringFunction | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:guardian | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:relationshipType | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship:dipsRelation | Base | preferred | Patient relationship type | 📍4.0.1 | FHIR Std. |
| RelatedPerson.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
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-4 | error | RelatedPerson | If 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-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from NoBasisRelatedPerson
Summary
Mandatory: 0 element(9 nested mandatory elements)
Fixed: 8 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
Search Parameters:
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching Related Person using the active search parameter:
GET [base]/RelatedPerson?active=[boolean]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the status of related person active or inactive ([how to search by string])
SHALL support searching Related Person using the address search parameter:
GET [base]/RelatedPerson?address=[string]
Example:
Implementation Notes: Fetches a bundle of all RelatedPerson resources that match the address ([how to search by string])
SHALL support searching Related Person using the address-city search parameter:
GET [base]/RelatedPerson?address-city=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the address city ([how to search by string])
SHALL support searching Related Person using the address-postalcode search parameter:
GET [base]/RelatedPerson?address-postalcode=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the address postalcode ([how to search by string])
SHALL support searching Related Person using the address-state search parameter:
GET [base]/RelatedPerson?address-state=[number]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the address state ([how to search by string])
SHALL support searching Related Person using the birthdate search parameter:
GET [base]/RelatedPerson?birthdate=[date]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the exact date of birth ([how to search by string])
SHALL support searching Related Person using the email search parameter:
GET [base]/RelatedPerson?email=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match email ([how to search by string])
SHALL support searching Related Person using the family search parameter:
GET [base]/RelatedPerson?family=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the family name ([how to search by string])
SHALL support searching Related Person using the family-contains search parameter:
GET [base]/RelatedPerson?family:contains=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the family name contains ([how to search by string])
SHALL support searching Related Person using the family-exact search parameter:
GET [base]/RelatedPerson?family:exact=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the exact family name ([how to search by string])
SHALL support searching Related Person using the gender search parameter:
GET [base]/RelatedPerson?gender=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the gender ([how to search by string])
SHALL support searching Related Person using the given search parameter:
GET [base]/RelatedPerson?given=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the given name ([how to search by string])
SHALL support searching Related Person using the given-contains search parameter:
GET [base]/RelatedPerson?given:contains=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the given name contains ([how to search by string])
SHALL support searching Related Person using the given-exact search parameter:
GET [base]/RelatedPerson?given:exact=[string]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the exact given name ([how to search by string])
SHALL support searching Related Person using the id search parameter:
GET [base]/RelatedPerson?_id=[id]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the id ([how to search by string])
SHALL support searching Related Person using the identifier search parameter:
GET [base]/RelatedPerson?identifier={system|}[code]
Example:
| GET [base]/RelatedPerson?identifier=urn:oid:2.16.578.1.12.4.1.4.1 | 16459947837 |
Implementation Notes: Fetches a bundle of all Related Person resources that match the identifier ([how to search by string])
SHALL support searching Related Person using the patient search parameter:
GET [base]/RelatedPerson?patient=[patient]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the patient logical id ([how to search by string])
SHALL support searching Related Person using the phone search parameter:
GET [base]/RelatedPerson?phone=[number]
Example:
Implementation Notes: Fetches a bundle of all Related Person resources that match the phone ([how to search by string])
SHALL support searching Related Person using the relationship search parameter:
GET [base]/RelatedPerson?relationship={system|}[code]
Example:
| GET [base]/RelatedPerson?relationship=urn:oid:1.3.6.1.4.1.9038.52.3508 | 3 |
Implementation Notes: Fetches a bundle of all Related Person resources that match the relationship ([how to search by string])