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

Resource Profile: openIMIS Patient

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:

Formal Views of Profile Content

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:

  • The element Patient.identifier is sliced based on the value of value:type.coding.code (Closed)
  • The element Patient.telecom is sliced based on the value of value:system (Closed)
  • The element Patient.address is sliced based on the value of value:use (Closed)
  • The element Patient.photo is sliced based on the value of exists:url (Closed)

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id 0..1stringPatient UUID
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-is-head S0..1booleanHead of Family
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head
... patient-profession 0..1CodeableConceptPatient 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..1booleanPatient Card Issued
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued
... patient-group-reference 0..1Reference(openIMIS Group)Patient Group Reference
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference
... patient-vulnerability-status 0..1booleanPatient Vulnerability Status
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status
... Slices for identifier S1..*IdentifierAn identifier for this patient
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptDescription of identifier
...... coding
....... code 0..1codeSymbol in syntax defined by the system
Binding: openIMIS Identifiers Value Set (required)
..... value 1..1stringThe value that is unique
.... identifier:Code S0..1IdentifierAn identifier for this patient
..... type
...... coding
....... code 1..1codePatient/Insuree openIMIS Code
Required Pattern: Code
..... value I0..1stringThe value that is unique
insureeCodeMustBeUnder13Chars: Length MUST be <= 12.
.... identifier:UUID 0..1IdentifierAn identifier for this patient
..... type
...... coding
....... code 1..1codePatient/Insuree openIMIS UUID
Required Pattern: UUID
... active 0..1booleanActive Policy
... name 1..1HumanNamePatient/Insuree official name
.... use 0..1codeusual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official
.... family S1..1stringFamily name (often called 'Surname')
.... given S1..1stringGiven names (not always 'first'). Includes middle names
... Slices for telecom 0..2ContactPointA contact detail for the individual
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... value 1..1stringThe actual contact point details
.... telecom:email 0..1ContactPointPatient/Insuree email
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:phone 0..1ContactPointPatient/Insuree phone
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
... gender S1..1codemale | female | other | unknown
... birthDate S1..1dateThe date of birth for the individual
... deceased[x] 0..0
... Slices for address S1..1AddressAn address for the individual
Slice: Unordered, Closed by value:use
.... address:All Slices Content/Rules for all slices
..... extension 2..*ExtensionMunicipality/Ward
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... type 0..1codepostal | physical | both
Required Pattern: physical
..... line 0..1stringStreet name, number, direction & P.O. Box etc.
..... city S1..1stringCity/Village
..... district S1..1stringDistrict
..... state S1..1stringState/Region
..... postalCode 0..0
..... country 0..0
.... address:FamilyAddress S0..1AddressAn address for the individual
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: home
.... address:InsureeAddress 0..1AddressAn address for the individual
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: temp
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status (Patient) (required)
... multipleBirth[x] 0..0
... Slices for photo S0..1AttachmentImage of the patient
Slice: Unordered, Closed by exists:url
.... photo:All Slices Content/Rules for all slices
..... contentType S1..1codeMime type of the content, with charset etc.
..... hash 1..1base64BinaryHash of the data (sha-1, base64ed)
..... title S1..1stringLabel to display in place of the data
..... creation S1..1dateTimeDate attachment was first created
.... photo:URL 0..1Attachmentused in GET Patient
..... data 0..0
..... url 1..1urlUri where the data can be found
..... size 1..1unsignedIntNumber of bytes of content (if url provided)
.... photo:Data 0..1Attachmentused in POST & PUT Patient
..... data 1..1base64BinaryData inline, base64ed
..... url 0..0
... contact 0..1BackboneElementHead of Family contact
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: Contact Relationship (Patient) (extensible)
.... name 1..1HumanNameA name associated with the contact person
..... use 0..0
..... text 0..0
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..1stringGiven 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringPatient UUID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-is-head S0..1booleanHead of Family
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head
... patient-education-level 0..1CodeableConceptPatient Education Level
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level
Binding: Education Level (Patient) (example)
... patient-profession 0..1CodeableConceptPatient 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..1booleanPatient Card Issued
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued
... patient-group-reference 0..1Reference(openIMIS Group)Patient Group Reference
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference
... patient-vulnerability-status 0..1booleanPatient Vulnerability Status
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Binding: openIMIS Identifiers Value Set (required)
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:Code SΣ0..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codePatient/Insuree openIMIS Code
Required Pattern: Code
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
insureeCodeMustBeUnder13Chars: Length MUST be <= 12.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:UUID Σ0..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codePatient/Insuree openIMIS UUID
Required Pattern: UUID
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanActive Policy
... name Σ1..1HumanNamePatient/Insuree official name
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.


Required Pattern: official
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom Σ0..2ContactPointA contact detail for the individual
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email Σ0..1ContactPointPatient/Insuree email
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone Σ0..1ContactPointPatient/Insuree phone
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateThe date of birth for the individual
... Slices for address SΣ1..1AddressAn address for the individual
Slice: Unordered, Closed by value:use
.... address:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 2..*ExtensionMunicipality/Ward
Slice: Unordered, Open by value:url
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Required Pattern: physical
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..1stringStreet 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..1stringCity/Village
Example General: Erewhon
..... district SΣ1..1stringDistrict
Example General: Madison
..... state SΣ1..1stringState/Region
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:FamilyAddress SΣ0..1AddressAn address for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:InsureeAddress Σ0..1AddressAn address for the individual
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use ?!Σ1..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Required Pattern: temp
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status (Patient) (required)
... Slices for photo S0..1AttachmentImage of the patient
Slice: Unordered, Closed by exists:url
.... photo:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime 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..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data 0..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ1..1base64BinaryHash of the data (sha-1, base64ed)
..... title SΣ1..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ1..1dateTimeDate attachment was first created
.... photo:URL 0..1Attachmentused in GET Patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ0..1codeMime 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..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... url Σ1..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ1..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
.... photo:Data 0..1Attachmentused in POST & PUT Patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ0..1codeMime 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..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... data 1..1base64BinaryData inline, base64ed
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
... contact I0..1BackboneElementHead of Family contact
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: Contact Relationship (Patient) (extensible)
.... name 1..1HumanNameA name associated with the contact person
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... patient-is-head 0..1booleanHead of Family
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Closed by value:type.coding.code
.... identifier:Code Σ0..1IdentifierAn identifier for this patient
... name Σ1..1HumanNamePatient/Insuree official name
.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... birthDate Σ1..1dateThe date of birth for the individual
... Slices for address Σ1..1AddressAn address for the individual
Slice: Unordered, Closed by value:use
.... address:All Slices Content/Rules for all slices
..... address-municipality 1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference 1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... city Σ1..1stringCity/Village
..... district Σ1..1stringDistrict
..... state Σ1..1stringState/Region
.... address:FamilyAddress Σ0..1AddressAn address for the individual
..... address-municipality 1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference 1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
.... address:InsureeAddress Σ0..1AddressAn address for the individual
..... address-municipality 1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference 1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
... photo 0..1AttachmentImage of the patient
Slice: Unordered, Closed by exists:url
.... photo:All Slices Content/Rules for all slices
..... contentType Σ1..1codeMime 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..1stringLabel to display in place of the data
..... creation Σ1..1dateTimeDate attachment was first created

doco 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:

  • The element Patient.identifier is sliced based on the value of value:type.coding.code (Closed)
  • The element Patient.telecom is sliced based on the value of value:system (Closed)
  • The element Patient.address is sliced based on the value of value:use (Closed)
  • The element Patient.photo is sliced based on the value of exists:url (Closed)

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id 0..1stringPatient UUID
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-is-head S0..1booleanHead of Family
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head
... patient-profession 0..1CodeableConceptPatient 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..1booleanPatient Card Issued
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued
... patient-group-reference 0..1Reference(openIMIS Group)Patient Group Reference
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference
... patient-vulnerability-status 0..1booleanPatient Vulnerability Status
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status
... Slices for identifier S1..*IdentifierAn identifier for this patient
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptDescription of identifier
...... coding
....... code 0..1codeSymbol in syntax defined by the system
Binding: openIMIS Identifiers Value Set (required)
..... value 1..1stringThe value that is unique
.... identifier:Code S0..1IdentifierAn identifier for this patient
..... type
...... coding
....... code 1..1codePatient/Insuree openIMIS Code
Required Pattern: Code
..... value I0..1stringThe value that is unique
insureeCodeMustBeUnder13Chars: Length MUST be <= 12.
.... identifier:UUID 0..1IdentifierAn identifier for this patient
..... type
...... coding
....... code 1..1codePatient/Insuree openIMIS UUID
Required Pattern: UUID
... active 0..1booleanActive Policy
... name 1..1HumanNamePatient/Insuree official name
.... use 0..1codeusual | official | temp | nickname | anonymous | old | maiden
Required Pattern: official
.... family S1..1stringFamily name (often called 'Surname')
.... given S1..1stringGiven names (not always 'first'). Includes middle names
... Slices for telecom 0..2ContactPointA contact detail for the individual
Slice: Unordered, Closed by value:system
.... telecom:All Slices Content/Rules for all slices
..... value 1..1stringThe actual contact point details
.... telecom:email 0..1ContactPointPatient/Insuree email
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
.... telecom:phone 0..1ContactPointPatient/Insuree phone
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
... gender S1..1codemale | female | other | unknown
... birthDate S1..1dateThe date of birth for the individual
... deceased[x] 0..0
... Slices for address S1..1AddressAn address for the individual
Slice: Unordered, Closed by value:use
.... address:All Slices Content/Rules for all slices
..... extension 2..*ExtensionMunicipality/Ward
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... type 0..1codepostal | physical | both
Required Pattern: physical
..... line 0..1stringStreet name, number, direction & P.O. Box etc.
..... city S1..1stringCity/Village
..... district S1..1stringDistrict
..... state S1..1stringState/Region
..... postalCode 0..0
..... country 0..0
.... address:FamilyAddress S0..1AddressAn address for the individual
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: home
.... address:InsureeAddress 0..1AddressAn address for the individual
..... address-municipality S1..1stringMunicipality (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-municipality
..... address-location-reference S1..1Reference(openIMIS Location)Location Reference (Address)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/address-location-reference
..... use 1..1codehome | work | temp | old | billing - purpose of this address
Required Pattern: temp
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status (Patient) (required)
... multipleBirth[x] 0..0
... Slices for photo S0..1AttachmentImage of the patient
Slice: Unordered, Closed by exists:url
.... photo:All Slices Content/Rules for all slices
..... contentType S1..1codeMime type of the content, with charset etc.
..... hash 1..1base64BinaryHash of the data (sha-1, base64ed)
..... title S1..1stringLabel to display in place of the data
..... creation S1..1dateTimeDate attachment was first created
.... photo:URL 0..1Attachmentused in GET Patient
..... data 0..0
..... url 1..1urlUri where the data can be found
..... size 1..1unsignedIntNumber of bytes of content (if url provided)
.... photo:Data 0..1Attachmentused in POST & PUT Patient
..... data 1..1base64BinaryData inline, base64ed
..... url 0..0
... contact 0..1BackboneElementHead of Family contact
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: Contact Relationship (Patient) (extensible)
.... name 1..1HumanNameA name associated with the contact person
..... use 0..0
..... text 0..0
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..1stringGiven 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringPatient UUID
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... patient-is-head S0..1booleanHead of Family
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-is-head
... patient-education-level 0..1CodeableConceptPatient Education Level
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-education-level
Binding: Education Level (Patient) (example)
... patient-profession 0..1CodeableConceptPatient 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..1booleanPatient Card Issued
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-card-issued
... patient-group-reference 0..1Reference(openIMIS Group)Patient Group Reference
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-group-reference
... patient-vulnerability-status 0..1booleanPatient Vulnerability Status
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/patient-vulnerability-status
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Closed by value:type.coding.code
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ1..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ0..1codeSymbol in syntax defined by the system
Binding: openIMIS Identifiers Value Set (required)
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:Code SΣ0..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ0..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codePatient/Insuree openIMIS Code
Required Pattern: Code
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣI0..1stringThe value that is unique
insureeCodeMustBeUnder13Chars: Length MUST be <= 12.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:UUID Σ0..1IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system