Patient Care Coordination (PCC) Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/R4/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: Patient

Extension of UKCore-Patient and includes elements from HL7 International Access

Usages:

• Refer to this Profile: Condition, ConsulationNote, DocumentReference, Observation... Show 4 more, PatientSummary, Procedure, QuestionnaireResponse and ServiceRequest
• Examples for this Profile: Patient/1107, Patient/1bec52a2-1bea-452f-a6ba-5eea5f97a24e, Patient/3, Patient/500029... Show 6 more, Patient/610, Patient/637, Patient/9449304424, Patient/9449310424, Patient/9730906181 and Patient/9876543210
• CapabilityStatements using this Profile: Facade - IM1 Patient EMIS, Facade - IM1 Transaction EMIS, Facade - IM1 Transaction TPP, NHS England Service Facade and Virtually Healthcare - Clinical Data Repository

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.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IPAPatient	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
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type Constraints: ipa-pat-1
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..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 (required)
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
identifier:MedicalRecordNumber	SΣC	0..*	MedicalRecordNumber	Medical Record Number Constraints: ipa-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
identifier:nhsNumber	SΣC	0..*	NHSNumber	UK National Health Identifiers Constraints: ipa-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
active	?!SΣC	0..1	boolean	Whether this patient's record is in active use Constraints: ipa-pat-4
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
link	?!SΣC	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	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:MedicalRecordNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
ipa-pat-1	error	Patient.identifier, Patient.identifier:MedicalRecordNumber, Patient.identifier:nhsNumber	At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present : system.exists() or type.exists() or assigner.exists()
ipa-pat-2	error	Patient.name	Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ipa-pat-3	best practice	Patient.name	To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists()
ipa-pat-4	error	Patient.active	If Patient.link is present, then Patient.active SHALL be present : link.exists() implies active.exists()

This structure is derived from IPAPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			IPAPatient
Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type
identifier:All Slices				Content/Rules for all slices
type		0..1	CodeableConcept	Description of identifier Binding: Identifier Type (required)
identifier:MedicalRecordNumber		0..*	MedicalRecordNumber	Medical Record Number
identifier:nhsNumber		0..*	NHSNumber	UK National Health Identifiers
name		1..*	HumanName	A name associated with the patient
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime	S	0..1	dateTime	Indicates if the individual is deceased or not
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IPAPatient	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
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type Constraints: ipa-pat-1
identifier:All Slices				Content/Rules for all slices
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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)
identifier:MedicalRecordNumber	SΣC	0..*	MedicalRecordNumber	Medical Record Number Constraints: ipa-pat-1
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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)
identifier:nhsNumber	SΣC	0..*	NHSNumber	UK National Health Identifiers Constraints: ipa-pat-1
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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ΣC	0..1	boolean	Whether this patient's record is in active use Constraints: ipa-pat-4
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3
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	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
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	Σ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	Σ	0..*	Address	An address for the individual
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	?!SΣC	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	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:MedicalRecordNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:MedicalRecordNumber.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nhsNumber.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
ipa-pat-1	error	Patient.identifier, Patient.identifier:MedicalRecordNumber, Patient.identifier:nhsNumber	At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present : system.exists() or type.exists() or assigner.exists()
ipa-pat-2	error	Patient.name	Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ipa-pat-3	best practice	Patient.name	To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists()
ipa-pat-4	error	Patient.active	If Patient.link is present, then Patient.active SHALL be present : link.exists() implies active.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 IPAPatient

Summary

Mandatory: 1 element
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Medical Record Number (https://fhir.virtually.healthcare/StructureDefinition/MedicalRecordNumber)
• NHS Number (https://fhir.virtually.healthcare/StructureDefinition/NHSNumber)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.deceased[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IPAPatient	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
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type Constraints: ipa-pat-1
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..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 (required)
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
identifier:MedicalRecordNumber	SΣC	0..*	MedicalRecordNumber	Medical Record Number Constraints: ipa-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
identifier:nhsNumber	SΣC	0..*	NHSNumber	UK National Health Identifiers Constraints: ipa-pat-1
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
active	?!SΣC	0..1	boolean	Whether this patient's record is in active use Constraints: ipa-pat-4
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
link	?!SΣC	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	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:MedicalRecordNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
ipa-pat-1	error	Patient.identifier, Patient.identifier:MedicalRecordNumber, Patient.identifier:nhsNumber	At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present : system.exists() or type.exists() or assigner.exists()
ipa-pat-2	error	Patient.name	Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ipa-pat-3	best practice	Patient.name	To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists()
ipa-pat-4	error	Patient.active	If Patient.link is present, then Patient.active SHALL be present : link.exists() implies active.exists()

Differential View

This structure is derived from IPAPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			IPAPatient
Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type
identifier:All Slices				Content/Rules for all slices
type		0..1	CodeableConcept	Description of identifier Binding: Identifier Type (required)
identifier:MedicalRecordNumber		0..*	MedicalRecordNumber	Medical Record Number
identifier:nhsNumber		0..*	NHSNumber	UK National Health Identifiers
name		1..*	HumanName	A name associated with the patient
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedDateTime	S	0..1	dateTime	Indicates if the individual is deceased or not
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	IPAPatient	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
Slices for identifier	SΣC	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:type Constraints: ipa-pat-1
identifier:All Slices				Content/Rules for all slices
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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)
identifier:MedicalRecordNumber	SΣC	0..*	MedicalRecordNumber	Medical Record Number Constraints: ipa-pat-1
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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)
identifier:nhsNumber	SΣC	0..*	NHSNumber	UK National Health Identifiers Constraints: ipa-pat-1
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	?!Σ	0..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 (required)
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. 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ΣC	0..1	boolean	Whether this patient's record is in active use Constraints: ipa-pat-4
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ipa-pat-2, ipa-pat-3
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	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
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	Σ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	Σ	0..*	Address	An address for the individual
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	?!SΣC	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	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:MedicalRecordNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:MedicalRecordNumber.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:nhsNumber.type	required	IdentifierTypeVH https://fhir.virtually.healthcare/ValueSet/IdentifierTypeVH From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
ipa-pat-1	error	Patient.identifier, Patient.identifier:MedicalRecordNumber, Patient.identifier:nhsNumber	At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present : system.exists() or type.exists() or assigner.exists()
ipa-pat-2	error	Patient.name	Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ipa-pat-3	best practice	Patient.name	To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists()
ipa-pat-4	error	Patient.active	If Patient.link is present, then Patient.active SHALL be present : link.exists() implies active.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 IPAPatient

Summary

Mandatory: 1 element
Must-Support: 3 elements

Structures

This structure refers to these other structures:

• Medical Record Number (https://fhir.virtually.healthcare/StructureDefinition/MedicalRecordNumber)
• NHS Number (https://fhir.virtually.healthcare/StructureDefinition/NHSNumber)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.deceased[x]

Other representations of profile: CSV, Excel, Schematron