NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide
1.0.0 - Release
NP Core Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-10-14 |
Definitions for the np-core-relatedperson resource profile
See the documentation on how to interpret the contents of this table
| 0. RelatedPerson | |||||||||
| Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. | ||||||||
| Short | A person that is related to a patient, but who is not a direct target of care | ||||||||
| Control | 0..* | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||||||
| 2. RelatedPerson.implicitRules | |||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||
| Short | A set of rules under which this content was created | ||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||
| Control | 0..1 | ||||||||
| Type | uri | ||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 4. RelatedPerson.modifierExtension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| Short | Extensions that cannot be ignored | ||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||||
| Summary | false | ||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||||
| 6. RelatedPerson.identifier | |||||||||
| Definition | Identifier for a person within a particular scope. | ||||||||
| Short | A human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| Slicing | This element introduces a set of slices on RelatedPerson.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||
| 8. RelatedPerson.identifier:nationalId | |||||||||
| Slice Name | nationalId | ||||||||
| Definition | Identifier for a person within a particular scope. | ||||||||
| Short | A human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal National ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 10. RelatedPerson.identifier:healthId | |||||||||
| Slice Name | healthId | ||||||||
| Definition | The unique health identifier assigned by MoHFS to this related person. Identifier for a person within a particular scope. | ||||||||
| Short | Nepal Health IDA human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal Health ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 12. RelatedPerson.identifier:citizenshipNumber | |||||||||
| Slice Name | citizenshipNumber | ||||||||
| Definition | The citizenship certificate number issued to this related person by the District Administration Office under MoHA. Identifier for a person within a particular scope. | ||||||||
| Short | Nepal Citizenship Certificate NumberA human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal Citizenship Certificate Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 14. RelatedPerson.identifier:healthInsuranceId | |||||||||
| Slice Name | healthInsuranceId | ||||||||
| Definition | The health insurance membership identifier issued to this related person by the Health Insurance Board (HIB). Identifier for a person within a particular scope. | ||||||||
| Short | Nepal Health Insurance IDA human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal Health Insurance ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 16. RelatedPerson.identifier:passportNumber | |||||||||
| Slice Name | passportNumber | ||||||||
| Definition | The passport number issued to this related person by the Department of Passports under MoFA. Identifier for a person within a particular scope. | ||||||||
| Short | Nepal Passport NumberA human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal Passport Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 18. RelatedPerson.identifier:ssfNumber | |||||||||
| Slice Name | ssfNumber | ||||||||
| Definition | The social security number issued to this related person by the Social Security Fund (SSF). Identifier for a person within a particular scope. | ||||||||
| Short | Nepal Social Security Fund NumberA human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1* | ||||||||
| Type | Identifier(Nepal Social Security Fund Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 20. RelatedPerson.active | |||||||||
| Definition | Whether this related person record is in active use. | ||||||||
| Short | Whether this related person's record is in active use | ||||||||
| Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||||||
| Control | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. | ||||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 22. RelatedPerson.patient | |||||||||
| Definition | The patient this person is related to. | ||||||||
| Short | The patient this person is related to | ||||||||
| Control | 1..1 | ||||||||
| Type | Reference(NP Core Patient, Patient) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | We need to know which patient this RelatedPerson is related to. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 24. RelatedPerson.relationship | |||||||||
| Definition | The nature of the relationship between a patient and the related person. | ||||||||
| Short | The nature of the relationship | ||||||||
| Control | 0..* | ||||||||
| Binding | The codes SHOULD be taken from PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1)The nature of the relationship between a patient and the related person. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 26. RelatedPerson.name | |||||||||
| Definition | A name associated with the person. | ||||||||
| Short | A name associated with the person | ||||||||
| Control | 0..* | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 28. RelatedPerson.address | |||||||||
| Definition | Address where the related person can be contacted or visited. | ||||||||
| Short | Address where the related person can be contacted or visited | ||||||||
| Control | 0..* | ||||||||
| Type | Address | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Need to keep track where the related person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
See the documentation on how to interpret the contents of this table
| 0. RelatedPerson | |||||||||
| 2. RelatedPerson.identifier | |||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Slicing | This element introduces a set of slices on RelatedPerson.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||
| 4. RelatedPerson.identifier:nationalId | |||||||||
| Slice Name | nationalId | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal National ID) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 6. RelatedPerson.identifier:healthId | |||||||||
| Slice Name | healthId | ||||||||
| Definition | The unique health identifier assigned by MoHFS to this related person. | ||||||||
| Short | Nepal Health ID | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Health ID) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 8. RelatedPerson.identifier:citizenshipNumber | |||||||||
| Slice Name | citizenshipNumber | ||||||||
| Definition | The citizenship certificate number issued to this related person by the District Administration Office under MoHA. | ||||||||
| Short | Nepal Citizenship Certificate Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Citizenship Certificate Number) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 10. RelatedPerson.identifier:healthInsuranceId | |||||||||
| Slice Name | healthInsuranceId | ||||||||
| Definition | The health insurance membership identifier issued to this related person by the Health Insurance Board (HIB). | ||||||||
| Short | Nepal Health Insurance ID | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Health Insurance ID) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 12. RelatedPerson.identifier:passportNumber | |||||||||
| Slice Name | passportNumber | ||||||||
| Definition | The passport number issued to this related person by the Department of Passports under MoFA. | ||||||||
| Short | Nepal Passport Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Passport Number) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 14. RelatedPerson.identifier:ssfNumber | |||||||||
| Slice Name | ssfNumber | ||||||||
| Definition | The social security number issued to this related person by the Social Security Fund (SSF). | ||||||||
| Short | Nepal Social Security Fund Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Social Security Fund Number) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 16. RelatedPerson.patient | |||||||||
| Type | Reference(NP Core Patient) | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 18. RelatedPerson.relationship | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 20. RelatedPerson.name | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| 22. RelatedPerson.address | |||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
See the documentation on how to interpret the contents of this table
| 0. RelatedPerson | |||||||||
| Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. | ||||||||
| Short | A person that is related to a patient, but who is not a direct target of care | ||||||||
| Control | 0..* | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||||||
| 2. RelatedPerson.id | |||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||
| Short | Logical id of this artifact | ||||||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||
| Control | 0..1 | ||||||||
| Type | id | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| 4. RelatedPerson.meta | |||||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||
| Short | Metadata about the resource | ||||||||
| Control | 0..1 | ||||||||
| Type | Meta | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 6. RelatedPerson.implicitRules | |||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||
| Short | A set of rules under which this content was created | ||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||
| Control | 0..1 | ||||||||
| Type | uri | ||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 8. RelatedPerson.language | |||||||||
| Definition | The base language in which the resource is written. | ||||||||
| Short | Language of the resource content | ||||||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||
| Control | 0..1 | ||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | code | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 10. RelatedPerson.text | |||||||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||
| Short | Text summary of the resource, for human interpretation | ||||||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||
| Control | 0..1 | ||||||||
| Type | Narrative | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | narrative, html, xhtml, display | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 12. RelatedPerson.contained | |||||||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||||||
| Short | Contained, inline Resources | ||||||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||||||
| Control | 0..* | ||||||||
| Type | Resource | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||||||
| 14. RelatedPerson.extension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| Short | Additional content defined by implementations | ||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||
| 16. RelatedPerson.modifierExtension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| Short | Extensions that cannot be ignored | ||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||||
| Summary | false | ||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||
| 18. RelatedPerson.identifier | |||||||||
| Definition | Identifier for a person within a particular scope. | ||||||||
| Short | A human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| Slicing | This element introduces a set of slices on RelatedPerson.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||||||
| 20. RelatedPerson.identifier:nationalId | |||||||||
| Slice Name | nationalId | ||||||||
| Definition | Identifier for a person within a particular scope. | ||||||||
| Short | A human identifier for this person | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal National ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 22. RelatedPerson.identifier:healthId | |||||||||
| Slice Name | healthId | ||||||||
| Definition | The unique health identifier assigned by MoHFS to this related person. | ||||||||
| Short | Nepal Health ID | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Health ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 24. RelatedPerson.identifier:citizenshipNumber | |||||||||
| Slice Name | citizenshipNumber | ||||||||
| Definition | The citizenship certificate number issued to this related person by the District Administration Office under MoHA. | ||||||||
| Short | Nepal Citizenship Certificate Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Citizenship Certificate Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 26. RelatedPerson.identifier:healthInsuranceId | |||||||||
| Slice Name | healthInsuranceId | ||||||||
| Definition | The health insurance membership identifier issued to this related person by the Health Insurance Board (HIB). | ||||||||
| Short | Nepal Health Insurance ID | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Health Insurance ID) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 28. RelatedPerson.identifier:passportNumber | |||||||||
| Slice Name | passportNumber | ||||||||
| Definition | The passport number issued to this related person by the Department of Passports under MoFA. | ||||||||
| Short | Nepal Passport Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Passport Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 30. RelatedPerson.identifier:ssfNumber | |||||||||
| Slice Name | ssfNumber | ||||||||
| Definition | The social security number issued to this related person by the Social Security Fund (SSF). | ||||||||
| Short | Nepal Social Security Fund Number | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Control | 0..1 | ||||||||
| Type | Identifier(Nepal Social Security Fund Number) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 32. RelatedPerson.active | |||||||||
| Definition | Whether this related person record is in active use. | ||||||||
| Short | Whether this related person's record is in active use | ||||||||
| Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||||||
| Control | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. | ||||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 34. RelatedPerson.patient | |||||||||
| Definition | The patient this person is related to. | ||||||||
| Short | The patient this person is related to | ||||||||
| Control | 1..1 | ||||||||
| Type | Reference(NP Core Patient) | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | We need to know which patient this RelatedPerson is related to. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 36. RelatedPerson.relationship | |||||||||
| Definition | The nature of the relationship between a patient and the related person. | ||||||||
| Short | The nature of the relationship | ||||||||
| Control | 0..* | ||||||||
| Binding | The codes SHOULD be taken from PatientRelationshipType (preferred to http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype|4.0.1)The nature of the relationship between a patient and the related person. | ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 38. RelatedPerson.name | |||||||||
| Definition | A name associated with the person. | ||||||||
| Short | A name associated with the person | ||||||||
| Control | 0..* | ||||||||
| Type | HumanName | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 40. RelatedPerson.telecom | |||||||||
| Definition | A contact detail for the person, e.g. a telephone number or an email address. | ||||||||
| Short | A contact detail for the person | ||||||||
| Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. | ||||||||
| Control | 0..* | ||||||||
| Type | ContactPoint | ||||||||
| Is Modifier | false | ||||||||
| Summary | true | ||||||||
| Requirements | People have (primary) ways to contact them in some way such as phone, email. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 42. RelatedPerson.gender | |||||||||
| Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||||||
| Short | male | female | other | unknown | ||||||||
| Control | 0..1 | ||||||||
| Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1)The gender of a person used for administrative purposes. | ||||||||
| Type | code | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Requirements | Needed for identification of the person, in combination with (at least) name and birth date. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 44. RelatedPerson.birthDate | |||||||||
| Definition | The date on which the related person was born. | ||||||||
| Short | The date on which the related person was born | ||||||||
| Control | 0..1 | ||||||||
| Type | date | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | true | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 46. RelatedPerson.address | |||||||||
| Definition | Address where the related person can be contacted or visited. | ||||||||
| Short | Address where the related person can be contacted or visited | ||||||||
| Control | 0..* | ||||||||
| Type | Address | ||||||||
| Is Modifier | false | ||||||||
| Must Support | true | ||||||||
| Obligations |
| ||||||||
| Summary | true | ||||||||
| Requirements | Need to keep track where the related person can be contacted per postal mail or visited. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 48. RelatedPerson.photo | |||||||||
| Definition | Image of the person. | ||||||||
| Short | Image of the person | ||||||||
| Control | 0..* | ||||||||
| Type | Attachment | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 50. RelatedPerson.period | |||||||||
| Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. | ||||||||
| Short | Period of time that this relationship is considered valid | ||||||||
| Control | 0..1 | ||||||||
| Type | Period | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 52. RelatedPerson.communication | |||||||||
| Definition | A language which may be used to communicate with about the patient's health. | ||||||||
| Short | A language which may be used to communicate with about the patient's health | ||||||||
| Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. | ||||||||
| Control | 0..* | ||||||||
| Type | BackboneElement | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 54. RelatedPerson.communication.id | |||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||
| Short | Unique id for inter-element referencing | ||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
| Is Modifier | false | ||||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||||
| Summary | false | ||||||||
| 56. RelatedPerson.communication.extension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||
| Short | Additional content defined by implementations | ||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Alternate Names | extensions, user content | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||
| 58. RelatedPerson.communication.modifierExtension | |||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||
| Control | 0..* | ||||||||
| Type | Extension | ||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||||
| Summary | true | ||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||
| Alternate Names | extensions, user content, modifiers | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||||
| 60. RelatedPerson.communication.language | |||||||||
| Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. | ||||||||
| Short | The language which can be used to communicate with the patient about his or her health | ||||||||
| Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||||||
| Control | 1..1 | ||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||||
| Type | CodeableConcept | ||||||||
| Is Modifier | false | ||||||||
| Summary | false | ||||||||
| Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||
| 62. RelatedPerson.communication.preferred | |||||||||
| Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). | ||||||||
| Short | Language preference indicator | ||||||||
| Comments | This language is specifically identified for communicating healthcare information. | ||||||||
| Control | 0..1 | ||||||||
| Type | boolean | ||||||||
| Is Modifier | false | ||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||||
| Summary | false | ||||||||
| Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. | ||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||||