WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build International flag

WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions

Resource Profile: ANC Patient

Official URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/anc-patient Version: 0.3.0
Draft as of 2024-04-09 Computable Name: ANCPatient

Usage:Workflow Task: Gather client details

ANC Patient

Usage:

Formal Views of Profile Content

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

This structure is derived from ANCBasePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
.... value S 1..1 string Unique identification
... name 1..* HumanName A name associated with the patient
.... family S 1..1 string Last name
.... given S 1..1 string First name
... telecom 0..* ContactPoint A contact detail for the individual
.... value S 1..1 string Mobile phone number
... birthDate S 0..1 date Date of birth
... address 0..* Address An address for the individual
.... line S 1..1 string Address
... contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... name S 1..1 HumanName Alternative contact's name
.... telecom 0..* ContactPoint A contact detail for the person
..... value S 0..1 string Alternative contact's phone number

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... disability S 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
... nationality S 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... birthTime S 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier An identifier for this patient
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Unique identification
Example General: 123456
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Last name
.... given SΣ 1..1 string First name
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... telecom-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string Mobile phone number
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


Fixed Value: female
... birthDate SΣ 0..1 date Date of birth
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... address-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... photo S 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 1..1 HumanName Alternative contact's name
.... telecom S 0..* ContactPoint A contact detail for the person
..... value SΣ 0..1 string Alternative contact's phone number
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner S 0..* Reference(ANC Practitioner | ANC PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(ANC Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredFixed Value: female
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... birthPlace S 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... disability S 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
... nationality S 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... birthTime S 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 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 ?!SΣ 1..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.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Unique identification
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 ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Last name
.... given SΣ 1..1 string First name
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
... telecom SΣ 0..* ContactPoint A contact detail 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
.... telecom-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string Mobile phone number
.... use ?!SΣ 1..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.


Fixed Value: female
... birthDate SΣ 0..1 date Date of birth
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* 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-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!SΣ 1..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).


Example General: both
.... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Address
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 Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo S 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... 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..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S 1..1 HumanName Alternative contact's name
.... telecom S 0..* ContactPoint A contact detail for the 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
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string Alternative contact's phone number
..... 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
.... 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 C 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
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(ANC Practitioner | ANC PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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
.... other SΣ 1..1 Reference(ANC Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredFixed Value: female
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
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.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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 ANCBasePatient

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ANCBasePatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
.... value S 1..1 string Unique identification
... name 1..* HumanName A name associated with the patient
.... family S 1..1 string Last name
.... given S 1..1 string First name
... telecom 0..* ContactPoint A contact detail for the individual
.... value S 1..1 string Mobile phone number
... birthDate S 0..1 date Date of birth
... address 0..* Address An address for the individual
.... line S 1..1 string Address
... contact 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
.... name S 1..1 HumanName Alternative contact's name
.... telecom 0..* ContactPoint A contact detail for the person
..... value S 0..1 string Alternative contact's phone number

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... disability S 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
... nationality S 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... birthTime S 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier An identifier for this patient
.... use ?!SΣ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Unique identification
Example General: 123456
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Last name
.... given SΣ 1..1 string First name
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... telecom-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string Mobile phone number
.... use ?!SΣ 1..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


Fixed Value: female
... birthDate SΣ 0..1 date Date of birth
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... address-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... photo S 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name S 1..1 HumanName Alternative contact's name
.... telecom S 0..* ContactPoint A contact detail for the person
..... value SΣ 0..1 string Alternative contact's phone number
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... generalPractitioner S 0..* Reference(ANC Practitioner | ANC PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(ANC Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredFixed Value: female
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* ANCBasePatient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
... religion S 0..1 CodeableConcept The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: ReligiousAffiliation (preferred)
... birthPlace S 0..1 Address Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... disability S 0..* CodeableConcept Condition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
... nationality S 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... birthTime S 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... reminder 1..1 boolean Woman wants to receive reminders during pregnancy
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/reminder
... educationLevel 1..1 CodeableConcept Highest level of education achieved
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/educationlevel
Binding: Highest level of education achieved Choices (required)
... occupation 1..* CodeableConcept Occupation
URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/occupation
Binding: Occupation Choices Grouper (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 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 ?!SΣ 1..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.

.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string Unique identification
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 ?!SΣ 1..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text SΣ 1..1 string Text representation of the full name
.... family SΣ 1..1 string Last name
.... given SΣ 1..1 string First name
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
... telecom SΣ 0..* ContactPoint A contact detail 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
.... telecom-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string Mobile phone number
.... use ?!SΣ 1..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.


Fixed Value: female
... birthDate SΣ 0..1 date Date of birth
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* 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-preferred S 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!SΣ 1..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).


Example General: both
.... text SΣ 1..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Address
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 Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo S 0..* Attachment Image of the patient
... contact SC 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... 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..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S 1..1 HumanName Alternative contact's name
.... telecom S 0..* ContactPoint A contact detail for the 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
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ 0..1 string Alternative contact's phone number
..... 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
.... 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 C 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
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(ANC Practitioner | ANC PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(ANC Organization) Organization that is the custodian of the patient record
... link ?!SΣ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... 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
.... other SΣ 1..1 Reference(ANC Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredFixed Value: female
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
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.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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 ANCBasePatient

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron