openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build
openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-patient | Version: 1.0.0 | |||
| Active as of 2022-05-31 | Responsible: openIMIS Initiative | Computable Name: OpenIMISPatient | ||
Defines a Patient for openIMIS which maps to an Insuree
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Summary
Mandatory: 14 elements (21 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
  id | 0..1 | string | Patient UUID | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 patient-is-head | S | 0..1 | boolean | Head of Family URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head |
| patient-education-level | 0..1 | CodeableConcept | Patient Education Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level Binding: Education Level (Patient) (example) | |
| patient-profession | 0..1 | CodeableConcept | Patient Profession Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-profession Binding: Profession (Patient) (example) | |
| patient-identification | 0..1 | (Complex) | Patient Identification URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-identification | |
| patient-card-issued | 0..1 | boolean | Patient Card Issued URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued | |
| patient-group-reference | 0..1 | Reference(openIMIS Group) | Patient Group Reference URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference | |
| patient-vulnerability-status | 0..1 | boolean | Patient Vulnerability Status URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status | |
  Slices for identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:type.coding.code |
  identifier:All Slices | Content/Rules for all slices | |||
 type | 1..1 | CodeableConcept | Description of identifier | |
 coding | ||||
  code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
 value | 1..1 | string | The value that is unique | |
| identifier:Code | S | 0..1 | Identifier | An identifier for this patient |
 type | ||||
 coding | ||||
| code | 1..1 | code | Patient/Insuree openIMIS Code Required Pattern: Code | |
 value | I | 0..1 | string | The value that is unique insureeCodeMustBeUnder13Chars: Length MUST be <= 12. |
 identifier:UUID | 0..1 | Identifier | An identifier for this patient | |
 type | ||||
| coding | ||||
| code | 1..1 | code | Patient/Insuree openIMIS UUID Required Pattern: UUID | |
| active | 0..1 | boolean | Active Policy | |
| name | 1..1 | HumanName | Patient/Insuree official name | |
| use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family | S | 1..1 | string | Family name (often called 'Surname') |
| given | S | 1..1 | string | Given names (not always 'first'). Includes middle names |
| Slices for telecom | 0..2 | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:system | |
| telecom:All Slices | Content/Rules for all slices | |||
| value | 1..1 | string | The actual contact point details | |
| telecom:email | 0..1 | ContactPoint | Patient/Insuree email | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| telecom:phone | 0..1 | ContactPoint | Patient/Insuree phone | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | S | 1..1 | date | The date of birth for the individual |
| deceased[x] | 0..0 | |||
| Slices for address | S | 1..1 | Address | An address for the individual Slice: Unordered, Closed by value:use |
| address:All Slices | Content/Rules for all slices | |||
 extension | 2..* | Extension | Municipality/Ward | |
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| type | 0..1 | code | postal | physical | both Required Pattern: physical | |
| line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
| city | S | 1..1 | string | City/Village |
| district | S | 1..1 | string | District |
| state | S | 1..1 | string | State/Region |
| postalCode | 0..0 | |||
| country | 0..0 | |||
| address:FamilyAddress | S | 0..1 | Address | An address for the individual |
 address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
| address:InsureeAddress | 0..1 | Address | An address for the individual | |
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: temp | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status (Patient) (required) | |
| multipleBirth[x] | 0..0 | |||
| Slices for photo | S | 0..1 | Attachment | Image of the patient Slice: Unordered, Closed by exists:url |
| photo:All Slices | Content/Rules for all slices | |||
| contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| hash | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | |
| title | S | 1..1 | string | Label to display in place of the data |
| creation | S | 1..1 | dateTime | Date attachment was first created |
| photo:URL | 0..1 | Attachment | used in GET Patient | |
| data | 0..0 | |||
| url | 1..1 | url | Uri where the data can be found | |
| size | 1..1 | unsignedInt | Number of bytes of content (if url provided) | |
| photo:Data | 0..1 | Attachment | used in POST & PUT Patient | |
| data | 1..1 | base64Binary | Data inline, base64ed | |
| url | 0..0 | |||
| contact | 0..1 | BackboneElement | Head of Family contact | |
| relationship | 0..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship (Patient) (extensible) | |
| name | 1..1 | HumanName | A name associated with the contact person | |
| use | 0..0 | |||
| text | 0..0 | |||
| family | 1..1 | string | Family name (often called 'Surname') | |
| given | 1..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix | 0..0 | |||
| suffix | 0..0 | |||
| period | 0..0 | |||
| communication | 0..0 | |||
 generalPractitioner | 0..* | Reference(openIMIS Health Facility Organization) | First Service Point | |
| managingOrganization | 0..0 | |||
| link | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
 id | Σ | 0..1 | string | Patient UUID | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| patient-is-head | S | 0..1 | boolean | Head of Family URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head | ||||
| patient-education-level | 0..1 | CodeableConcept | Patient Education Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level Binding: Education Level (Patient) (example) | |||||
| patient-profession | 0..1 | CodeableConcept | Patient Profession Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-profession Binding: Profession (Patient) (example) | |||||
| patient-identification | 0..1 | (Complex) | Patient Identification URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-identification | |||||
| patient-card-issued | 0..1 | boolean | Patient Card Issued URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued | |||||
| patient-group-reference | 0..1 | Reference(openIMIS Group) | Patient Group Reference URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference | |||||
| patient-vulnerability-status | 0..1 | boolean | Patient Vulnerability Status URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:type.coding.code | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Code | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Patient/Insuree openIMIS Code Required Pattern: Code | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | ΣI | 0..1 | string | The value that is unique insureeCodeMustBeUnder13Chars: Length MUST be <= 12. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:UUID | Σ | 0..1 | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Patient/Insuree openIMIS UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Active Policy | ||||
| name | Σ | 1..1 | HumanName | Patient/Insuree official name | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 1..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 | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 0..2 | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:email | Σ | 0..1 | ContactPoint | Patient/Insuree email | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:phone | Σ | 0..1 | ContactPoint | Patient/Insuree phone | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
| Slices for address | SΣ | 1..1 | Address | An address for the individual Slice: Unordered, Closed by value:use | ||||
| address:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 2..* | Extension | Municipality/Ward Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 1..1 | string | City/Village Example General: Erewhon | ||||
| district | SΣ | 1..1 | string | District Example General: Madison | ||||
| state | SΣ | 1..1 | string | State/Region | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| address:FamilyAddress | SΣ | 0..1 | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| address:InsureeAddress | Σ | 0..1 | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: temp | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status (Patient) (required) | |||||
| Slices for photo | S | 0..1 | Attachment | Image of the patient Slice: Unordered, Closed by exists:url | ||||
| photo:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | SΣ | 1..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | SΣ | 1..1 | dateTime | Date attachment was first created | ||||
| photo:URL | 0..1 | Attachment | used in GET Patient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| url | Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| photo:Data | 0..1 | Attachment | used in POST & PUT Patient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 1..1 | base64Binary | Data inline, base64ed | |||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| contact | I | 0..1 | BackboneElement | Head of Family contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship (Patient) (extensible) | |||||
| name | 1..1 | HumanName | A name associated with the contact person | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| family | Σ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 1..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 | ||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| generalPractitioner | 0..* | Reference(openIMIS Health Facility Organization) | First Service Point | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| patient-is-head | 0..1 | boolean | Head of Family URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head | |
| Slices for identifier | Σ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:type.coding.code |
| identifier:Code | Σ | 0..1 | Identifier | An identifier for this patient |
| name | Σ | 1..1 | HumanName | Patient/Insuree official name |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 1..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 |
| gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 1..1 | date | The date of birth for the individual |
| Slices for address | Σ | 1..1 | Address | An address for the individual Slice: Unordered, Closed by value:use |
| address:All Slices | Content/Rules for all slices | |||
| address-municipality | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | |
| address-location-reference | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | |
| city | Σ | 1..1 | string | City/Village |
| district | Σ | 1..1 | string | District |
| state | Σ | 1..1 | string | State/Region |
| address:FamilyAddress | Σ | 0..1 | Address | An address for the individual |
| address-municipality | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | |
| address-location-reference | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | |
| address:InsureeAddress | Σ | 0..1 | Address | An address for the individual |
| address-municipality | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | |
| address-location-reference | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | |
| photo | 0..1 | Attachment | Image of the patient Slice: Unordered, Closed by exists:url | |
| photo:All Slices | Content/Rules for all slices | |||
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| title | Σ | 1..1 | string | Label to display in place of the data |
| creation | Σ | 1..1 | dateTime | Date attachment was first created |
| Documentation for this format | ||||
This structure is derived from Patient
Summary
Mandatory: 14 elements (21 nested mandatory elements)
Must-Support: 22 elements
Prohibited: 14 elements
Structures
This structure refers to these other structures:
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 |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| id | 0..1 | string | Patient UUID | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| patient-is-head | S | 0..1 | boolean | Head of Family URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head |
| patient-education-level | 0..1 | CodeableConcept | Patient Education Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level Binding: Education Level (Patient) (example) | |
| patient-profession | 0..1 | CodeableConcept | Patient Profession Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-profession Binding: Profession (Patient) (example) | |
| patient-identification | 0..1 | (Complex) | Patient Identification URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-identification | |
| patient-card-issued | 0..1 | boolean | Patient Card Issued URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued | |
| patient-group-reference | 0..1 | Reference(openIMIS Group) | Patient Group Reference URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference | |
| patient-vulnerability-status | 0..1 | boolean | Patient Vulnerability Status URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status | |
| Slices for identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:type.coding.code |
| identifier:All Slices | Content/Rules for all slices | |||
| type | 1..1 | CodeableConcept | Description of identifier | |
| coding | ||||
| code | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | |
| value | 1..1 | string | The value that is unique | |
| identifier:Code | S | 0..1 | Identifier | An identifier for this patient |
| type | ||||
| coding | ||||
| code | 1..1 | code | Patient/Insuree openIMIS Code Required Pattern: Code | |
| value | I | 0..1 | string | The value that is unique insureeCodeMustBeUnder13Chars: Length MUST be <= 12. |
| identifier:UUID | 0..1 | Identifier | An identifier for this patient | |
| type | ||||
| coding | ||||
| code | 1..1 | code | Patient/Insuree openIMIS UUID Required Pattern: UUID | |
| active | 0..1 | boolean | Active Policy | |
| name | 1..1 | HumanName | Patient/Insuree official name | |
| use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official | |
| family | S | 1..1 | string | Family name (often called 'Surname') |
| given | S | 1..1 | string | Given names (not always 'first'). Includes middle names |
| Slices for telecom | 0..2 | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:system | |
| telecom:All Slices | Content/Rules for all slices | |||
| value | 1..1 | string | The actual contact point details | |
| telecom:email | 0..1 | ContactPoint | Patient/Insuree email | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: email | |
| telecom:phone | 0..1 | ContactPoint | Patient/Insuree phone | |
| system | 1..1 | code | phone | fax | email | pager | url | sms | other Required Pattern: phone | |
| gender | S | 1..1 | code | male | female | other | unknown |
| birthDate | S | 1..1 | date | The date of birth for the individual |
| deceased[x] | 0..0 | |||
| Slices for address | S | 1..1 | Address | An address for the individual Slice: Unordered, Closed by value:use |
| address:All Slices | Content/Rules for all slices | |||
| extension | 2..* | Extension | Municipality/Ward | |
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| type | 0..1 | code | postal | physical | both Required Pattern: physical | |
| line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
| city | S | 1..1 | string | City/Village |
| district | S | 1..1 | string | District |
| state | S | 1..1 | string | State/Region |
| postalCode | 0..0 | |||
| country | 0..0 | |||
| address:FamilyAddress | S | 0..1 | Address | An address for the individual |
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: home | |
| address:InsureeAddress | 0..1 | Address | An address for the individual | |
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality |
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference |
| use | 1..1 | code | home | work | temp | old | billing - purpose of this address Required Pattern: temp | |
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status (Patient) (required) | |
| multipleBirth[x] | 0..0 | |||
| Slices for photo | S | 0..1 | Attachment | Image of the patient Slice: Unordered, Closed by exists:url |
| photo:All Slices | Content/Rules for all slices | |||
| contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
| hash | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | |
| title | S | 1..1 | string | Label to display in place of the data |
| creation | S | 1..1 | dateTime | Date attachment was first created |
| photo:URL | 0..1 | Attachment | used in GET Patient | |
| data | 0..0 | |||
| url | 1..1 | url | Uri where the data can be found | |
| size | 1..1 | unsignedInt | Number of bytes of content (if url provided) | |
| photo:Data | 0..1 | Attachment | used in POST & PUT Patient | |
| data | 1..1 | base64Binary | Data inline, base64ed | |
| url | 0..0 | |||
| contact | 0..1 | BackboneElement | Head of Family contact | |
| relationship | 0..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship (Patient) (extensible) | |
| name | 1..1 | HumanName | A name associated with the contact person | |
| use | 0..0 | |||
| text | 0..0 | |||
| family | 1..1 | string | Family name (often called 'Surname') | |
| given | 1..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix | 0..0 | |||
| suffix | 0..0 | |||
| period | 0..0 | |||
| communication | 0..0 | |||
| generalPractitioner | 0..* | Reference(openIMIS Health Facility Organization) | First Service Point | |
| managingOrganization | 0..0 | |||
| link | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | string | Patient UUID | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| patient-is-head | S | 0..1 | boolean | Head of Family URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head | ||||
| patient-education-level | 0..1 | CodeableConcept | Patient Education Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level Binding: Education Level (Patient) (example) | |||||
| patient-profession | 0..1 | CodeableConcept | Patient Profession Level URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-profession Binding: Profession (Patient) (example) | |||||
| patient-identification | 0..1 | (Complex) | Patient Identification URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-identification | |||||
| patient-card-issued | 0..1 | boolean | Patient Card Issued URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued | |||||
| patient-group-reference | 0..1 | Reference(openIMIS Group) | Patient Group Reference URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference | |||||
| patient-vulnerability-status | 0..1 | boolean | Patient Vulnerability Status URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Closed by value:type.coding.code | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: openIMIS Identifiers Value Set (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Code | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Patient/Insuree openIMIS Code Required Pattern: Code | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | ΣI | 0..1 | string | The value that is unique insureeCodeMustBeUnder13Chars: Length MUST be <= 12. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:UUID | Σ | 0..1 | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Patient/Insuree openIMIS UUID Required Pattern: UUID | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Active Policy | ||||
| name | Σ | 1..1 | HumanName | Patient/Insuree official name | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | SΣ | 1..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 | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | Σ | 0..2 | ContactPoint | A contact detail for the individual Slice: Unordered, Closed by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:email | Σ | 0..1 | ContactPoint | Patient/Insuree email | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:phone | Σ | 0..1 | ContactPoint | Patient/Insuree phone | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
| Slices for address | SΣ | 1..1 | Address | An address for the individual Slice: Unordered, Closed by value:use | ||||
| address:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 2..* | Extension | Municipality/Ward Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Required Pattern: physical | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 1..1 | string | City/Village Example General: Erewhon | ||||
| district | SΣ | 1..1 | string | District Example General: Madison | ||||
| state | SΣ | 1..1 | string | State/Region | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| address:FamilyAddress | SΣ | 0..1 | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| address:InsureeAddress | Σ | 0..1 | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| address-municipality | S | 1..1 | string | Municipality (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality | ||||
| address-location-reference | S | 1..1 | Reference(openIMIS Location) | Location Reference (Address) URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference | ||||
| use | ?!Σ | 1..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Required Pattern: temp | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status (Patient) (required) | |||||
| Slices for photo | S | 0..1 | Attachment | Image of the patient Slice: Unordered, Closed by exists:url | ||||
| photo:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 0..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 1..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | SΣ | 1..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | SΣ | 1..1 | dateTime | Date attachment was first created | ||||
| photo:URL | 0..1 | Attachment | used in GET Patient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| url | Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 1..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| photo:Data | 0..1 | Attachment | used in POST & PUT Patient | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 1..1 | base64Binary | Data inline, base64ed | |||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| contact | I | 0..1 | BackboneElement | Head of Family contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | 0..1 | CodeableConcept | The kind of relationship Binding: Contact Relationship (Patient) (extensible) | |||||
| name | 1..1 | HumanName | A name associated with the contact person | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| family | Σ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 1..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 | ||||
| telecom | 0..* | ContactPoint | A contact detail for the person | |||||
| address | 0..1 | Address | Address for the contact person | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| generalPractitioner | 0..* | Reference(openIMIS Health Facility Organization) | First Service Point | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Patient.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | extensible | Identifier Type Codes |
| Patient.identifier.type.coding.code | required | OpenIMISIdentifierVS |
| Patient.identifier:Code.use | required | IdentifierUse |
| Patient.identifier:Code.type | extensible | Identifier Type Codes |
| Patient.identifier:UUID.use | required | IdentifierUse |
| Patient.identifier:UUID.type | extensible | Identifier Type Codes |
| Patient.name.use | required | Pattern: official |
| Patient.telecom.system | required | ContactPointSystem |
| Patient.telecom.use | required | ContactPointUse |
| Patient.telecom:email.system | required | Pattern: email |
| Patient.telecom:email.use | required | ContactPointUse |
| Patient.telecom:phone.system | required | Pattern: phone |
| Patient.telecom:phone.use | required | ContactPointUse |
| Patient.gender | required | AdministrativeGender |
| Patient.address.use | required | AddressUse |
| Patient.address.type | required | Pattern: physical |
| Patient.address:FamilyAddress.use | required | Pattern: home |
| Patient.address:FamilyAddress.type | required | AddressType |
| Patient.address:InsureeAddress.use | required | Pattern: temp |
| Patient.address:InsureeAddress.type | required | AddressType |
| Patient.maritalStatus | required | PatientMaritalStatusVS |
| Patient.photo.contentType | required | Mime Types |
| Patient.photo.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.photo:URL.contentType | required | Mime Types |
| Patient.photo:URL.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.photo:Data.contentType | required | Mime Types |
| Patient.photo:Data.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.contact.relationship | extensible | PatientContactRelationshipVS |
| Patient.contact.gender | required | AdministrativeGender |
| Patient.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Patient.link.type | required | LinkType |
| Id | Grade | Path | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:isHead | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:isHead | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:educationLevel | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:educationLevel | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:profession | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:profession | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:identification | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:identification | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:cardIssued | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:cardIssued | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:group | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:group | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.extension:vulnerability | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.extension:vulnerability | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:Code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:Code.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:Code.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:Code.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:Code.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:Code.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| insureeCodeMustBeUnder13Chars | error | Patient.identifier:Code.value | Length MUST be <= 12. : $this.length() <= 12 | |
| ele-1 | error | Patient.identifier:Code.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:Code.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:UUID.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:UUID.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:UUID.type.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:UUID.type.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.identifier:UUID.type.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.identifier:UUID.type.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.type.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.identifier:UUID.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.name.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.name.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.name.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.telecom.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.telecom.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.telecom:email.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.telecom:email.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:email.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.telecom:phone.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.telecom:phone.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.telecom:phone.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address.extension:municipality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address.extension:municipality | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address.extension:location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address.extension:location | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:FamilyAddress.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:FamilyAddress.extension:municipality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:FamilyAddress.extension:municipality | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:FamilyAddress.extension:location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:FamilyAddress.extension:location | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:FamilyAddress.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:FamilyAddress.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:InsureeAddress.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:InsureeAddress.extension:municipality | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:InsureeAddress.extension:municipality | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:InsureeAddress.extension:location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.address:InsureeAddress.extension:location | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.address:InsureeAddress.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.address:InsureeAddress.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.photo.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.photo.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.data | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.photo:URL.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.photo:URL.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:URL.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.photo:Data.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.photo:Data.contentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.data | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.size | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.hash | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.photo:Data.creation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| ele-1 | error | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.name.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.contact.name.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.contact.name.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.name.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |