Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: OHH Patient

Patient profile for ohh patient resources

Usages:

• Use this Profile: Encrypted Questionnaire Response Profile
• Refer to this Profile: Ohh Base Care Plan Profile and Ohh Care Team Profile
• Examples for this Profile: Patient/patient

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.identifier		1..*	Identifier	An identifier for this patient
Patient.identifier.type		0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.name	S This element must be supported.	0..1	HumanName	A name associated with the patient
Patient.name.text	S This element must be supported.	0..1	string	Text representation of the full name
Patient.Slices for telecom	S This element must be supported.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported.	0..1	string	The actual contact point details
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	A name associated with the patient
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for telecom	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.system	Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Patient.Slices for telecom.telecom:email.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	string	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	A name associated with the patient
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for telecom	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.system	Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Patient.Slices for telecom.telecom:email.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:email.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.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.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		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 Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

• https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.identifier		1..*	Identifier	An identifier for this patient
Patient.identifier.type		0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.name	S This element must be supported.	0..1	HumanName	A name associated with the patient
Patient.name.text	S This element must be supported.	0..1	string	Text representation of the full name
Patient.Slices for telecom	S This element must be supported.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported.	0..1	string	The actual contact point details
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	A name associated with the patient
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for telecom	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.system	Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Patient.Slices for telecom.telecom:email.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: exactly-one-official-program-patient, no-system-identifier-rules
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:patientSignature	S This element must be supported.	0..1	string	Patient Signature Extension URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	string	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: OHH Patient Identifier Type Value Set (required)
Patient.identifier.system	Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	Σ This element is included in summaries.	0..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.name	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	A name associated with the patient
Patient.name.id		0..1	string	Unique id for inter-element referencing
Patient.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.name.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.name.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.name.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.name.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for telecom	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for telecom.telecom:email	S This element must be supported. Σ This element is included in summaries.	0..1	ContactPoint	A contact detail for the individual
Patient.Slices for telecom.telecom:email.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for telecom.telecom:email.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for telecom.telecom:email.system	Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email (extensions allowed)
Patient.Slices for telecom.telecom:email.value	S This element must be supported. Σ This element is included in summaries.	0..1	string	The actual contact point details
Patient.Slices for telecom.telecom:email.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
Patient.Slices for telecom.telecom:email.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.Slices for telecom.telecom:email.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.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.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		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 Bindings Purpose AllLanguages Max Binding
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	required	OHH Patient Identifier Type Value Set	📦0.1.0	This IG
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	extensible	MaritalStatus	📍4.0.1	FHIR Std.
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
exactly-one-official-program-patient	error	Patient	If there are multiple identifiers, exactly one must have use = 'official'	identifier.where(system != 'urn:ietf:rfc:3986').count() <= 1 or identifier.where(system != 'urn:ietf:rfc:3986' and use = 'official').count() = 1
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-system-identifier-rules	error	Patient	Identifiers without a system must have type.coding with system 'http://terminology.hl7.org/CodeSystem/v2-0203' and code 'PT'	identifier.where(system.empty()).all(type.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0203' and code = 'PT').exists())
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

• https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/patient-signature

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom

Other representations of profile: CSV, Excel, Schematron