Amakomaya Nepal FHIR Implementation Guide
2.0.0 - ci-build Nepal

Amakomaya Nepal FHIR Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: AMK Core Patient Profile

Official URL: https://fhir.amakomaya.com/StructureDefinition/amk-core-patient | Version: 2.0.0
Active as of 2025-12-11 | Computable Name: AMKCorePatientProfile
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The AMK Core Patient Profile inherits from the FHIR Patient resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Patient resource to record, search, and fetch core patient information within the Nepal health system. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. By providing a standardized foundation for capturing patient demographics, identifiers, and key health attributes, this profile promotes interoperability, consistent data capture, and adoption across national health programs

Usages:

- Refer to this Profile: AMK Core Immunization Profile and AMK Core Medication Dispense Profile
- Examples for this Profile: Patient/patient-child and Patient/patient-pregnant

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier | Σ | 1..* | Identifier | An identifier for this patient
use | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system | S Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value | Σ C | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Text representation of the full name
telecom | Σ | 1..* | ContactPoint | A contact detail for the individual
gender | S Σ | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate | Σ | 0..1 | date | Date of birth
deceased[x] | ?!Σ | 0..1 |  | Indicates if/when the individual is deceased
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..1 | Address | An address for the individual
text | S Σ | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24) Example General: 137 Nowhere Street, Erewhon 9132
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
photo |  | 0..1 | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | Emergency or alternate contact person for the patient Constraints: pat-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
name | S C | 0..1 | HumanName | A name associated with the contact person
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Full name of the contact person
telecom | S C | 0..1 | ContactPoint | A contact detail for the person
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ C | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3
Patient.contact.name.​use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.communication.​language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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())`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
identifier |  | 1..* | Identifier | An identifier for this patient
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official
system | S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value |  | 1..1 | string | The value that is unique
name |  | 1..* | HumanName | A name associated with the patient
text |  | 1..1 | string | Text representation of the full name
telecom |  | 1..* | ContactPoint | A contact detail for the individual
gender | S | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate |  | 0..1 | date | Date of birth
address | S | 0..1 | Address | An address for the individual
use |  | 0..0 |  | home | work | temp | old | billing - purpose of this address
type |  | 0..0 |  | postal | physical | both
text | S | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24)
line |  | 0..0 |  | Street name, number, direction & P.O. Box etc.
city |  | 0..0 |  | Name of city, town etc.
district |  | 0..0 |  | District name (aka county)
state |  | 0..0 |  | Sub-unit of country (abbreviations ok)
postalCode |  | 0..0 |  | Postal code for area
country |  | 0..0 |  | Country (e.g. may be ISO 3166 2 or 3 letter code)
period |  | 0..0 |  | Time period when address was/is in use
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient
photo |  | 0..1 | Attachment | Image of the patient
contact | S | 0..* | BackboneElement | Emergency or alternate contact person for the patient
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
name | S | 0..1 | HumanName | A name associated with the contact person
text |  | 1..1 | string | Full name of the contact person
telecom | S | 0..1 | ContactPoint | A contact detail for the person
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value |  | 1..1 | string | The actual contact point details
use |  | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
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
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier | Σ | 1..* | Identifier | An identifier for this 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 | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value | Σ C | 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 patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..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'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name 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 | Σ | 1..* | ContactPoint | A contact detail for the individual
gender | S Σ | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate | Σ | 0..1 | date | Date of birth
deceased[x] | ?!Σ | 0..1 |  | Indicates if/when the individual is deceased
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..1 | Address | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
text | S Σ | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24) Example General: 137 Nowhere Street, Erewhon 9132
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..1 | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | Emergency or alternate contact person for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
role |  | 0..* | CodeableConcept | The kind of functional role Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person.
name | S C | 0..1 | HumanName | A name associated with the contact 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Full name of the contact person
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name 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
additionalName |  | 0..* | HumanName | Additional names for the contact person
telecom | S C | 0..1 | ContactPoint | A contact detail for the 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
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ C | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | C | 0..1 | Address | Address for the contact person
additionalAddress |  | 0..* | Address | Additional addresses for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.identifier.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3
Patient.contact.role | Base | preferred | Patient Relationship Type | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.name.​use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std.
Patient.communication.​language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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())`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`

This structure is derived from Patient

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 9 elements

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier | Σ | 1..* | Identifier | An identifier for this patient
use | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system | S Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value | Σ C | 1..1 | string | The value that is unique Example General: 123456
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with the patient
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Text representation of the full name
telecom | Σ | 1..* | ContactPoint | A contact detail for the individual
gender | S Σ | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate | Σ | 0..1 | date | Date of birth
deceased[x] | ?!Σ | 0..1 |  | Indicates if/when the individual is deceased
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..1 | Address | An address for the individual
text | S Σ | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24) Example General: 137 Nowhere Street, Erewhon 9132
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
photo |  | 0..1 | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | Emergency or alternate contact person for the patient Constraints: pat-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
name | S C | 0..1 | HumanName | A name associated with the contact person
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Full name of the contact person
telecom | S C | 0..1 | ContactPoint | A contact detail for the person
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ C | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.identifier.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3
Patient.contact.name.​use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.communication.​language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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())`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`

Differential View

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
identifier |  | 1..* | Identifier | An identifier for this patient
use | S | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official
system | S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value |  | 1..1 | string | The value that is unique
name |  | 1..* | HumanName | A name associated with the patient
text |  | 1..1 | string | Text representation of the full name
telecom |  | 1..* | ContactPoint | A contact detail for the individual
gender | S | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate |  | 0..1 | date | Date of birth
address | S | 0..1 | Address | An address for the individual
use |  | 0..0 |  | home | work | temp | old | billing - purpose of this address
type |  | 0..0 |  | postal | physical | both
text | S | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24)
line |  | 0..0 |  | Street name, number, direction & P.O. Box etc.
city |  | 0..0 |  | Name of city, town etc.
district |  | 0..0 |  | District name (aka county)
state |  | 0..0 |  | Sub-unit of country (abbreviations ok)
postalCode |  | 0..0 |  | Postal code for area
country |  | 0..0 |  | Country (e.g. may be ISO 3166 2 or 3 letter code)
period |  | 0..0 |  | Time period when address was/is in use
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient
photo |  | 0..1 | Attachment | Image of the patient
contact | S | 0..* | BackboneElement | Emergency or alternate contact person for the patient
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
name | S | 0..1 | HumanName | A name associated with the contact person
text |  | 1..1 | string | Full name of the contact person
telecom | S | 0..1 | ContactPoint | A contact detail for the person
system |  | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone
value |  | 1..1 | string | The actual contact point details
use |  | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Required Pattern: mobile
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
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: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
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
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
identifier | Σ | 1..* | Identifier | An identifier for this 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 | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://api.amakomaya.com/NamingSystem/nepal-telecom-subscriber
value | Σ C | 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 patient's record is in active use
name | Σ | 1..* | HumanName | A name associated with 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..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'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name 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 | Σ | 1..* | ContactPoint | A contact detail for the individual
gender | S Σ | 0..1 | code | Gender of the person Binding: Administrative Gender (required)
birthDate | Σ | 0..1 | date | Date of birth
deceased[x] | ?!Σ | 0..1 |  | Indicates if/when the individual is deceased
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..1 | Address | An address for the individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
text | S Σ | 0..1 | string | Plus Code / location algorithm text (format: P8JV+24) Example General: 137 Nowhere Street, Erewhon 9132
maritalStatus |  | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
multipleBirth[x] |  | 0..1 |  | Whether patient is part of a multiple birth
multipleBirthBoolean |  |  | boolean |
multipleBirthInteger |  |  | integer |
photo |  | 0..1 | Attachment | Image of the patient
contact | S C | 0..* | BackboneElement | Emergency or alternate contact person for the patient Constraints: pat-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
relationship | S | 0..1 | CodeableConcept | Relationship of the contact person to the patient Binding: PersonalRelationshipRoleType (required)
role |  | 0..* | CodeableConcept | The kind of functional role Binding: PatientRelationshipType (preferred): The nature of the personal relationship between the patient and the contact person.
name | S C | 0..1 | HumanName | A name associated with the contact 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 | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 1..1 | string | Full name of the contact person
family | Σ | 0..1 | string | Family name (often called 'Surname')
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name 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
additionalName |  | 0..* | HumanName | Additional names for the contact person
telecom | S C | 0..1 | ContactPoint | A contact detail for the 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
system | Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value | Σ C | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Required Pattern: mobile
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
address | C | 0..1 | Address | Address for the contact person
additionalAddress |  | 0..* | Address | Additional addresses for the contact person
gender |  | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact
period |  | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  | 0..1 | BackboneElement | A language which may be used to communicate with the patient about his or her health
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
language |  | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Slice: Unordered, Open by value:url
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Patient.language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.identifier.use | Base | required | IdentifierUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.identifier.type | Base | extensible | Identifier Type Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.name.use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.gender | Base | required | Administrative Gender | 📦2.0.0 | This IG
Patient.maritalStatus | Base | extensible | Marital Status Codes | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.relationship | Base | required | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.3
Patient.contact.role | Base | preferred | Patient Relationship Type | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.name.​use | Base | required | NameUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​system | Base | required | ContactPointSystem | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.telecom.​use | Base | required | ContactPointUse | 📍6.0.0-ballot5 | FHIR Std.
Patient.contact.gender | Base | required | AdministrativeGender | 📍6.0.0-ballot5 | FHIR Std.
Patient.communication.​language | Base | required | All Languages | 📍6.0.0-ballot5 | FHIR Std.
Patient.link.type | Base | required | Link Type | 📍6.0.0-ballot5 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Patient | 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Patient | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Patient | 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())`
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization | `name.exists() or telecom.exists() or address.exists() or organization.exists()`

This structure is derived from Patient

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Must-Support: 9 elements
Prohibited: 9 elements

Other representations of profile: CSV, Excel, Schematron