Zambia Traning
1.0.0 - STU1
Zambia Traning, published by My Organization. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Training and changes regularly. See the Directory of published versions
Official URL: http://openhie.org/fhir/zambia-training/StructureDefinition/test-patient | Version: 1.0.0 | |||
Active as of 2024-02-16 | Computable Name: TestPatient |
Test Patient for training
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |
![]() ![]() ![]() | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
![]() ![]() ![]() ![]() ![]() | C | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:NID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:MR.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') | |
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |||||
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |||||
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | C | 1..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() | C | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | C | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 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
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.identifier:NID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:NID.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.identifier:MR.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:MR.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.telecom:EMAIL.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.maritalStatus | extensible | MaritalStatusCodeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.communication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') | |
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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: 4 elements (10 nested mandatory elements)
Must-Support: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |
![]() ![]() ![]() | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The actual contact point details | |
![]() ![]() ![]() ![]() | S | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
![]() ![]() ![]() ![]() ![]() | C | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | phone | fax | email | pager | url | sms | other | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | Σ | 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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.identifier:NID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:MR.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') | |
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() | 0..1 | CodeableConcept | HIV Key Pop URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop Binding: Key Population Status (extensible) | |||||
![]() ![]() ![]() | 0..1 | dateTime | HIV Key Pop Date URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date | |||||
![]() ![]() ![]() | 0..1 | (Complex) | HIV Pop Status Complex URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex | |||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() | Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The actual contact point details PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234 | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() | Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | dateTime | |||||||
![]() ![]() ![]() | Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() | 0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() | boolean | |||||||
![]() ![]() ![]() ![]() | integer | |||||||
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() | C | 1..1 | HumanName | A name associated with the contact person | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() | C | 0..* | ContactPoint | A contact detail for the person | ||||
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() | C | 0..1 | Address | Address for the contact person | ||||
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | 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
| |||||
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() | ?!Σ | 0..* | BackboneElement | Link to a Patient or RelatedPerson resource that concerns the same actual individual | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() | Σ | 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 | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Patient.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.identifier:NID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:NID.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.identifier:MR.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Patient.identifier:MR.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Patient.telecom:EMAIL.system | required | Pattern: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:EMAIL.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.system | required | Pattern: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.telecom:PHOME.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.maritalStatus | extensible | MaritalStatusCodeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | |
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | |
Patient.contact.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|5.0.0 from the FHIR Standard | |
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|5.0.0 from the FHIR Standard | |
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0 from the FHIR Standard | |
Patient.communication.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
PATIENT-PHONE-1 | error | Patient.telecom:PHOME.value | Only special characters (dash) and numbers are allowed. For example: 083-123-1234 : $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}') | |
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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').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()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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: 4 elements (10 nested mandatory elements)
Must-Support: 3 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron