HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
1.0.0 - STU1
HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, published by My Organization. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/rmrlangford/Botswana-Training and changes regularly. See the Directory of published versions
Official URL: http://openhie.org/fhir/botswana-training/StructureDefinition/hiv-patient | Version: 1.0.0 | |||
Active as of 2023-09-25 | Computable Name: HIVPatient |
An HIV patient getting services
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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/omang | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: MR | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Medical record number | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Patient folder number | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/mrn | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PPN | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Passport number | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Passport number | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/passport | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/refugee | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/birth-certificate | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/biometric | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/residence | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/foreign | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/drivers | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() | 1..1 | code | male | female | other | unknown | |
![]() ![]() ![]() | 1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() | 1..* | Address | An address for the individual | |
![]() ![]() ![]() ![]() | 1..1 | code | postal | physical | both | |
![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | 1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 1..1 | string | District name (aka county) | |
![]() ![]() ![]() ![]() | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Marital (civil) status of a patient | |
![]() ![]() ![]() | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() |
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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/omang |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/mrn |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/passport |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/refugee |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/birth-certificate |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/biometric |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/residence |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/foreign |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/drivers |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | Σ | 1..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
![]() ![]() ![]() ![]() | SC | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() | ?!Σ | 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 |
Patient.identifier:OmangID.use | required | IdentifierUse |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:PPN.use | required | IdentifierUse |
Patient.identifier:RefugeeID.use | required | IdentifierUse |
Patient.identifier:BirthCertificateID.use | required | IdentifierUse |
Patient.identifier:Biometric.use | required | IdentifierUse |
Patient.identifier:Residence.use | required | IdentifierUse |
Patient.identifier:Foreign.use | required | IdentifierUse |
Patient.identifier:Drivers.use | required | IdentifierUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.type | required | AddressType |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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() |
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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/omang |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: MR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Medical record number |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Patient folder number |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/mrn |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PPN |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Passport number |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Passport number |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/passport |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | 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/botswana-training/identifier/refugee |
![]() ![]() ![]() ![]() ![]() | Σ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 | 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/botswana-training/identifier/birth-certificate |
![]() ![]() ![]() ![]() ![]() | Σ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 | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/biometric |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/residence |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | 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/botswana-training/identifier/foreign |
![]() ![]() ![]() ![]() ![]() | Σ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 | 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/botswana-training/identifier/drivers |
![]() ![]() ![]() ![]() ![]() | Σ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..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 1..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 |
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | Σ | 1..* | Address | An address 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 | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | 1..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 | |
![]() ![]() ![]() | SC | 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 |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
![]() ![]() ![]() ![]() | C | 0..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 |
![]() ![]() ![]() ![]() | SC | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | 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 |
Patient.language | required | AllLanguages |
Patient.identifier:OmangID.use | required | IdentifierUse |
Patient.identifier:OmangID.type | extensible | IdentifierTypeCodes |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:MRN.type | extensible | IdentifierTypeCodes |
Patient.identifier:PPN.use | required | IdentifierUse |
Patient.identifier:PPN.type | extensible | IdentifierTypeCodes |
Patient.identifier:RefugeeID.use | required | IdentifierUse |
Patient.identifier:RefugeeID.type | extensible | IdentifierTypeCodes |
Patient.identifier:BirthCertificateID.use | required | IdentifierUse |
Patient.identifier:BirthCertificateID.type | extensible | IdentifierTypeCodes |
Patient.identifier:Biometric.use | required | IdentifierUse |
Patient.identifier:Biometric.type | extensible | IdentifierTypeCodes |
Patient.identifier:Residence.use | required | IdentifierUse |
Patient.identifier:Residence.type | extensible | IdentifierTypeCodes |
Patient.identifier:Foreign.use | required | IdentifierUse |
Patient.identifier:Foreign.type | extensible | IdentifierTypeCodes |
Patient.identifier:Drivers.use | required | IdentifierUse |
Patient.identifier:Drivers.type | extensible | IdentifierTypeCodes |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.type | required | AddressType |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.contact.name.use | required | NameUse |
Patient.contact.gender | required | AdministrativeGender |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 18 elements (26 nested mandatory elements)
Must-Support: 5 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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/omang | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: MR | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Medical record number | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Patient folder number | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/mrn | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PPN | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system Required Pattern: Passport number | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept Required Pattern: Passport number | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/passport | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/refugee | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/birth-certificate | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 1..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/biometric | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/residence | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/foreign | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() | 0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/drivers | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | The value that is unique | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() | 1..1 | code | male | female | other | unknown | |
![]() ![]() ![]() | 1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() | 1..* | Address | An address for the individual | |
![]() ![]() ![]() ![]() | 1..1 | code | postal | physical | both | |
![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
![]() ![]() ![]() ![]() | 1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() | 1..1 | string | District name (aka county) | |
![]() ![]() ![]() ![]() | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | Marital (civil) status of a patient | |
![]() ![]() ![]() | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() | 1..* | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() |
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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/omang |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/mrn |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/passport |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/refugee |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/birth-certificate |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 1..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/biometric |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/residence |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/foreign |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | Σ | 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/botswana-training/identifier/drivers |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | Σ | 1..* | Address | An address for the individual |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() | 1..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person. | |
![]() ![]() ![]() | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
![]() ![]() ![]() ![]() | SC | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() | ?!Σ | 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 |
Patient.identifier:OmangID.use | required | IdentifierUse |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:PPN.use | required | IdentifierUse |
Patient.identifier:RefugeeID.use | required | IdentifierUse |
Patient.identifier:BirthCertificateID.use | required | IdentifierUse |
Patient.identifier:Biometric.use | required | IdentifierUse |
Patient.identifier:Residence.use | required | IdentifierUse |
Patient.identifier:Foreign.use | required | IdentifierUse |
Patient.identifier:Drivers.use | required | IdentifierUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.type | required | AddressType |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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() |
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 | |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nation(s) where the patient claims citizenship URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship |
![]() ![]() ![]() | S | 0..1 | (Complex) | Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 2..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | (Complex) | Omang ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/omang-id | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/omang |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Omang ID is split into two. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: MR |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Medical record number |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Patient folder number |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/mrn |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: MRN ID can be issued by many different systems. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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. |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PPN |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Passport number |
![]() ![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Passport number |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/botswana-training/identifier/passport |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple passport IDs. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | 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/botswana-training/identifier/refugee |
![]() ![]() ![]() ![]() ![]() | Σ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 | 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/botswana-training/identifier/birth-certificate |
![]() ![]() ![]() ![]() ![]() | Σ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 | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/biometric |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: Biometric ID can be issued by many different systems. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..* | (Complex) | Parent Extension for ID URL: http://openhie.org/fhir/botswana-training/StructureDefinition/parent | |
![]() ![]() ![]() ![]() ![]() | ?!Σ | 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/botswana-training/identifier/residence |
![]() ![]() ![]() ![]() ![]() | ΣC | 1..1 | string | The value that is unique Required Pattern: A patient can have multiple residence IDs. |
![]() ![]() ![]() ![]() ![]() | Σ | 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 | 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/botswana-training/identifier/foreign |
![]() ![]() ![]() ![]() ![]() | Σ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 | 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/botswana-training/identifier/drivers |
![]() ![]() ![]() ![]() ![]() | Σ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..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 1..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 |
![]() ![]() ![]() | Σ | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
![]() ![]() ![]() | Σ | 1..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | Σ | 1..* | Address | An address 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 | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home |
![]() ![]() ![]() ![]() | Σ | 1..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | District name (aka county) Example General: Madison |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Postal code for area Example General: 9132 |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Country (e.g. may be ISO 3166 2 or 3 letter code) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | 1..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 | |
![]() ![]() ![]() | SC | 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 |
![]() ![]() ![]() ![]() | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |
![]() ![]() ![]() ![]() | C | 0..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 |
![]() ![]() ![]() ![]() | SC | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | 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 |
Patient.language | required | AllLanguages |
Patient.identifier:OmangID.use | required | IdentifierUse |
Patient.identifier:OmangID.type | extensible | IdentifierTypeCodes |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:MRN.type | extensible | IdentifierTypeCodes |
Patient.identifier:PPN.use | required | IdentifierUse |
Patient.identifier:PPN.type | extensible | IdentifierTypeCodes |
Patient.identifier:RefugeeID.use | required | IdentifierUse |
Patient.identifier:RefugeeID.type | extensible | IdentifierTypeCodes |
Patient.identifier:BirthCertificateID.use | required | IdentifierUse |
Patient.identifier:BirthCertificateID.type | extensible | IdentifierTypeCodes |
Patient.identifier:Biometric.use | required | IdentifierUse |
Patient.identifier:Biometric.type | extensible | IdentifierTypeCodes |
Patient.identifier:Residence.use | required | IdentifierUse |
Patient.identifier:Residence.type | extensible | IdentifierTypeCodes |
Patient.identifier:Foreign.use | required | IdentifierUse |
Patient.identifier:Foreign.type | extensible | IdentifierTypeCodes |
Patient.identifier:Drivers.use | required | IdentifierUse |
Patient.identifier:Drivers.type | extensible | IdentifierTypeCodes |
Patient.name.use | required | NameUse |
Patient.gender | required | AdministrativeGender |
Patient.address.use | required | AddressUse |
Patient.address.type | required | AddressType |
Patient.maritalStatus | extensible | MaritalStatusCodes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.contact.name.use | required | NameUse |
Patient.contact.gender | required | AdministrativeGender |
Patient.communication.language | required | AllLanguages |
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
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: 18 elements (26 nested mandatory elements)
Must-Support: 5 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron