Overview

Patient is the main entity in TRxHub. Based on a Patient, other entities like a Coverage or a ServiceRequest can be created. TRxHub itself does not store the data provided. It only stores the identifier and the TRxHub ID. Therefore, when reading a patient, only the identifier and the TRxHub ID are returned.

In the future there may be added the functionality to read all the patient data.

Identifier

The identifier allows the external service to set an identifier for a patient from their system for easier identification.

Telecom

Telecom defines the means to contact a patient. Available systems are: email and phone. At least one entry of either phone or email is required.

The format of the values is not validated.

Address

Allowed codes for use are home and billing.

home represents the patient's address where the medication will be sent and must be provided.

billing represents the patient's address where the bill will be sent. This entry is optional and depends on who will be billed for the medication.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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. Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	SΣ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:phone	SΣ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value	SΣ	1..1	string	The actual contact point details
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.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	SΣ	1..1	Address	An address for the individual
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	Name of city, town etc. Example General: Erewhon
postalCode	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
address:billing	SΣ	0..1	Address	An address for the individual
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: billing
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	Name of city, town etc. Example General: Erewhon
postalCode	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
link	?!Σ	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	Σ	1..1	Reference(Patient | RelatedPerson)	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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
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.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:billing.​use	Base	required	AddressUse	📍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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
identifier	S	1..1	Identifier	An identifier for this patient
name	S	1..1	HumanName	A name associated with the patient
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..1	string	Given names (not always 'first'). Includes middle names
Slices for telecom	S	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: email
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
telecom:phone	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: phone
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
gender	S	1..1	code	male | female | other | unknown
birthDate	S	1..1	date	The date of birth for the individual
Slices for address	S	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	S	1..1	Address	An address for the individual
use	S	1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: home
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
city	S	1..1	string	Name of city, town etc.
postalCode	S	1..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
address:billing	S	0..1	Address	An address for the individual
use	S	1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: billing
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
city	S	1..1	string	Name of city, town etc.
postalCode	S	1..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	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 Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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. Required Pattern: official
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	SΣ	0..*	ContactPoint	A contact detail for the individual
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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value	SΣ	1..1	string	The actual contact point details
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
telecom:phone	SΣ	0..*	ContactPoint	A contact detail for the individual
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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value	SΣ	1..1	string	The actual contact point details
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.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	SΣ	1..1	Address	An address for the individual
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	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	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:billing	SΣ	0..1	Address	An address for the individual
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: billing
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	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	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..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		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	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		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		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
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	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	Σ	1..1	Reference(Patient | RelatedPerson)	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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
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.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address:billing.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:billing.​type	Base	required	AddressType	📍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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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. Required Pattern: official
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	SΣ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	1..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:phone	SΣ	0..*	ContactPoint	A contact detail for the individual
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value	SΣ	1..1	string	The actual contact point details
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.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	SΣ	1..1	Address	An address for the individual
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	Name of city, town etc. Example General: Erewhon
postalCode	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
address:billing	SΣ	0..1	Address	An address for the individual
use	?!SΣ	1..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: billing
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	Name of city, town etc. Example General: Erewhon
postalCode	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
link	?!Σ	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	Σ	1..1	Reference(Patient | RelatedPerson)	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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
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.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:billing.​use	Base	required	AddressUse	📍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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	Information about an individual or animal receiving health care services
identifier	S	1..1	Identifier	An identifier for this patient
name	S	1..1	HumanName	A name associated with the patient
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Required Pattern: official
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..1	string	Given names (not always 'first'). Includes middle names
Slices for telecom	S	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: email
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
telecom:phone	S	0..*	ContactPoint	A contact detail for the individual
system	S	1..1	code	phone | fax | email | pager | url | sms | other Fixed Value: phone
value	S	1..1	string	The actual contact point details
use	S	1..1	code	home | work | temp | old | mobile - purpose of this contact point
gender	S	1..1	code	male | female | other | unknown
birthDate	S	1..1	date	The date of birth for the individual
Slices for address	S	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	S	1..1	Address	An address for the individual
use	S	1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: home
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
city	S	1..1	string	Name of city, town etc.
postalCode	S	1..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
address:billing	S	0..1	Address	An address for the individual
use	S	1..1	code	home | work | temp | old | billing - purpose of this address Fixed Value: billing
line	S	1..1	string	Street name, number, direction & P.O. Box etc.
city	S	1..1	string	Name of city, town etc.
postalCode	S	1..1	string	Postal code for area
country	S	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	Patient	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 Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..1	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	1..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. Required Pattern: official
text	Σ	0..1	string	Text representation of the full name
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..1	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	SΣ	1..*	ContactPoint	A contact detail for the individual Slice: Unordered, Closed by value:system
telecom:email	SΣ	0..*	ContactPoint	A contact detail for the individual
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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email
value	SΣ	1..1	string	The actual contact point details
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
telecom:phone	SΣ	0..*	ContactPoint	A contact detail for the individual
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	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value	SΣ	1..1	string	The actual contact point details
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.
birthDate	SΣ	1..1	date	The date of birth for the individual
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
Slices for address	SΣ	1..*	Address	An address for the individual Slice: Unordered, Closed by value:use
address:home	SΣ	1..1	Address	An address for the individual
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	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	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
address:billing	SΣ	0..1	Address	An address for the individual
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	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: billing
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	1..1	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	1..1	string	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	SΣ	1..1	string	Postal code for area Example General: 9132
country	SΣ	1..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		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
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		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	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		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		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
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	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	Σ	1..1	Reference(Patient | RelatedPerson)	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.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
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.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address:home.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:home.​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address:billing.​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address:billing.​type	Base	required	AddressType	📍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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.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: 15 elements(11 nested mandatory elements)
Must-Support: 29 elements
Fixed: 4 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom (Closed)
• The element 1 is sliced based on the value of Patient.address (Closed)