Zambia Traning
1.0.0 - STU1 International flag

Zambia Traning, published by My Organization. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Training and changes regularly. See the Directory of published versions

Resource Profile: Test Patient

Official URL: http://openhie.org/fhir/zambia-training/StructureDefinition/test-patient Version: 1.0.0
Active as of 2024-02-16 Computable Name: TestPatient

Test Patient for training

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... HIVPOPSTATUS 0..1CodeableConceptHIV Key Pop
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop
Binding: Key Population Status (extensible)
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... Slices for identifier 1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID S0..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value 1..1stringThe value that is unique
.... identifier:MR 1..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value 1..1stringThe value that is unique
... Slices for telecom 0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL S0..1ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1stringThe actual contact point details
.... telecom:PHOME S0..1ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value C1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
... contact
.... name 1..1HumanNameA name associated with the contact person
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..*stringGiven names (not always 'first'). Includes middle names
.... telecom
..... system 1..1codephone | fax | email | pager | url | sms | other

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... COMPLEXHIVPopStatus 0..1(Complex)HIV Pop Status Complex
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID SΣ0..1IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value ΣC1..1stringThe value that is unique
Example General: 123456
.... identifier:MR Σ1..1IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value ΣC1..1stringThe value that is unique
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL SΣ0..1ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

.... telecom:PHOME SΣ0..1ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:MR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... 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
... HIVPOPSTATUS 0..1CodeableConceptHIV Key Pop
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop
Binding: Key Population Status (extensible)
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... COMPLEXHIVPopStatus 0..1(Complex)HIV Pop Status Complex
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID SΣ0..1IdentifierAn identifier for this patient
..... id 0..1idUnique 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value ΣC1..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:MR Σ1..1IdentifierAn identifier for this patient
..... id 0..1idUnique 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value ΣC1..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..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL SΣ0..1ContactPointA contact detail for the individual
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC1..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:PHOME SΣ0..1ContactPointA contact detail for the individual
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
..... 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 Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... 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..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name C1..1HumanNameA name associated with the contact person
..... id 0..1idUnique 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.

..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..*stringGiven 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
.... telecom C0..*ContactPointA contact detail for the person
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value ΣC0..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
.... address C0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... 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
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual individual
.... 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
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.identifier:NID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:NID.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:MR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:MR.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.telecom:EMAIL.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 4 elements (10 nested mandatory elements)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system
  • The element Patient.telecom is sliced based on the value of value:system

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... HIVPOPSTATUS 0..1CodeableConceptHIV Key Pop
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop
Binding: Key Population Status (extensible)
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... Slices for identifier 1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID S0..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value 1..1stringThe value that is unique
.... identifier:MR 1..1IdentifierAn identifier for this patient
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value 1..1stringThe value that is unique
... Slices for telecom 0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL S0..1ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: email
..... value 1..1stringThe actual contact point details
.... telecom:PHOME S0..1ContactPointA contact detail for the individual
..... system 1..1codephone | fax | email | pager | url | sms | other
Required Pattern: phone
..... value C1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
... contact
.... name 1..1HumanNameA name associated with the contact person
..... family 1..1stringFamily name (often called 'Surname')
..... given 1..*stringGiven names (not always 'first'). Includes middle names
.... telecom
..... system 1..1codephone | fax | email | pager | url | sms | other

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... COMPLEXHIVPopStatus 0..1(Complex)HIV Pop Status Complex
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID SΣ0..1IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value ΣC1..1stringThe value that is unique
Example General: 123456
.... identifier:MR Σ1..1IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value ΣC1..1stringThe value that is unique
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL SΣ0..1ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


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

.... telecom:PHOME SΣ0..1ContactPointA contact detail for the individual
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:MR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... 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
... HIVPOPSTATUS 0..1CodeableConceptHIV Key Pop
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-key-pop
Binding: Key Population Status (extensible)
... HIVPOPSTATUSDate 0..1dateTimeHIV Key Pop Date
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-date
... COMPLEXHIVPopStatus 0..1(Complex)HIV Pop Status Complex
URL: http://openhie.org/fhir/zambia-training/StructureDefinition/hiv-pop-status-complex
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NID SΣ0..1IdentifierAn identifier for this patient
..... id 0..1idUnique 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/nid
..... value ΣC1..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:MR Σ1..1IdentifierAn identifier for this patient
..... id 0..1idUnique 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: http://openhie.org/fhir/zambia-training/identifier/mr
..... value ΣC1..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..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... Slices for telecom Σ0..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:EMAIL SΣ0..1ContactPointA contact detail for the individual
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: email
..... value ΣC1..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:PHOME SΣ0..1ContactPointA contact detail for the individual
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Required Pattern: phone
..... value ΣC1..1stringThe actual contact point details
PATIENT-PHONE-1: Only special characters (dash) and numbers are allowed. For example: 083-123-1234
..... 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 Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... 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..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name C1..1HumanNameA name associated with the contact person
..... id 0..1idUnique 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.

..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ1..*stringGiven 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
.... telecom C0..*ContactPointA contact detail for the person
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value ΣC0..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
.... address C0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... 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
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to a Patient or RelatedPerson resource that concerns the same actual individual
.... 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
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.identifier:NID.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:NID.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:MR.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:MR.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.telecom:EMAIL.systemrequiredPattern: email
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:EMAIL.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.systemrequiredPattern: phone
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.telecom:PHOME.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.maritalStatusextensibleMaritalStatusCodes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|5.0.0
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|5.0.0
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|5.0.0
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
PATIENT-PHONE-1errorPatient.telecom:PHOME.valueOnly special characters (dash) and numbers are allowed. For example: 083-123-1234
: $this.matches('[0-9]{1,3}-[0-9]{1,3}-[0-9]{4}')
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 4 elements (10 nested mandatory elements)
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system
  • The element Patient.telecom is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron