WOF Connect📍, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions

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

Resource Profile: Wof Connect Patient

Patient returned by WOF Connect integrations.

Usages:

• Examples for this Profile: Patient/Patient-GetByPersonalNumberExample
• CapabilityStatements using this Profile: WOF Connect Capability Statement

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	C	0..*	Patient	Information about an individual or animal receiving health care services Constraints: no-id-requires-identifier
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
versionId	Σ	0..1	id	Version ID for the meta element
profile	SΣ	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
tag	Σ	1..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
code	SΣ	1..1	code	System the data originates from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of the consent to marketing communication extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	SΣ	1..*	Coding	Coded type of the identifier
text	SΣ	0..1	string	Type of identifier
system	Σ	0..1	uri	System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Value of the identifier Example General: 123456
identifier:personalNumber	SΣ	1..1	Identifier	National personal number for the patient
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	SΣ	1..*	Coding	Coded type of the identifier
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: PN
text	SΣ	0..1	string	Type of identifier
system	Σ	1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Personal number value Example General: 123456
active	?!SΣ	0..1	boolean	Whether the patient record is active or not
name	SOΣ	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Full name of the patient
family	Σ	0..1	string	Family name of the patient often called 'surname / last name'
given	Σ	0..1	string	Given name of the patient often called 'first name' This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	OΣ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	SΣ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	Patient phone number Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	SΣ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	Patient email address Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	SOΣ	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
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.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG
Patient.name.use	Base	required	NameUse	📍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.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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.exists()

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: no-id-requires-identifier
id	S	1..1	id	Logical id of this artifact
meta	S	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
versionId		0..1	id	Version ID for the meta element
profile	S	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
tag		1..*	Coding	Tags applied to this resource
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
code	S	1..1	code	System the data originates from
extension	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
extension		0..0		Extension
value[x]		0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Value of the consent to marketing communication extension
Slices for identifier	SO	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
identifier:All Slices				Content/Rules for all slices
type
coding	S	1..*	Coding	Coded type of the identifier
text	S	0..1	string	Type of identifier
system		0..1	uri	System that issued the identifier (e.g. hospital, government)
value		1..1	string	Value of the identifier
identifier:personalNumber	S	1..1	Identifier	National personal number for the patient
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Required Pattern: PN
system		1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible)
value		1..1	string	Personal number value
active	S	0..1	boolean	Whether the patient record is active or not
name	SO	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
text	S	1..1	string	Full name of the patient
family		0..1	string	Family name of the patient often called 'surname / last name'
given		0..1	string	Given name of the patient often called 'first name'
Slices for telecom	O	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	S	0..1	ContactPoint	A contact detail for the individual
system		1..1	code	Patient phone number Required Pattern: phone
telecom:email	S	0..1	ContactPoint	A contact detail for the individual
system		1..1	code	Patient email address Required Pattern: email
birthDate	SO	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.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: no-id-requires-identifier
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version ID for the meta element
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	1..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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Σ	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	System the data originates from
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of the consent to marketing communication extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Coded type of the identifier
text	SΣ	0..1	string	Type of identifier
system	Σ	0..1	uri	System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Value of the identifier 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:personalNumber	SΣ	1..1	Identifier	National personal number for 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	?!Σ	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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Coded type of the identifier
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: PN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Type of identifier
system	Σ	1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Personal number value 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Σ	0..1	boolean	Whether the patient record is active or not
name	SOΣ	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
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	SΣ	1..1	string	Full name of the patient
family	Σ	0..1	string	Family name of the patient often called 'surname / last name'
given	Σ	0..1	string	Given name of the patient often called 'first name' This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	OΣ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	SΣ	0..1	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	ΣC	1..1	code	Patient phone number Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	SΣ	0..1	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	ΣC	1..1	code	Patient email address Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SOΣ	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
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	?!Σ	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.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
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	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG
Patient.name.use	Base	required	NameUse	📍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.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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.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: 14 elements(4 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 1 element

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.telecom

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: no-id-requires-identifier
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
versionId	Σ	0..1	id	Version ID for the meta element
profile	SΣ	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
tag	Σ	1..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	SΣ	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
code	SΣ	1..1	code	System the data originates from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
extension	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of the consent to marketing communication extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	SΣ	1..*	Coding	Coded type of the identifier
text	SΣ	0..1	string	Type of identifier
system	Σ	0..1	uri	System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Value of the identifier Example General: 123456
identifier:personalNumber	SΣ	1..1	Identifier	National personal number for the patient
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	SΣ	1..*	Coding	Coded type of the identifier
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: PN
text	SΣ	0..1	string	Type of identifier
system	Σ	1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Personal number value Example General: 123456
active	?!SΣ	0..1	boolean	Whether the patient record is active or not
name	SOΣ	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	1..1	string	Full name of the patient
family	Σ	0..1	string	Family name of the patient often called 'surname / last name'
given	Σ	0..1	string	Given name of the patient often called 'first name' This repeating element order: Given Names appear in the correct order for presenting the name
Slices for telecom	OΣ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	SΣ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	Patient phone number Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	SΣ	0..1	ContactPoint	A contact detail for the individual
system	ΣC	1..1	code	Patient email address Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
birthDate	SOΣ	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
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.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG
Patient.name.use	Base	required	NameUse	📍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.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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.exists()

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: no-id-requires-identifier
id	S	1..1	id	Logical id of this artifact
meta	S	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
versionId		0..1	id	Version ID for the meta element
profile	S	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
tag		1..*	Coding	Tags applied to this resource
system	S	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
code	S	1..1	code	System the data originates from
extension	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
extension		0..0		Extension
value[x]		0..1	base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta	Value of the consent to marketing communication extension
Slices for identifier	SO	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
identifier:All Slices				Content/Rules for all slices
type
coding	S	1..*	Coding	Coded type of the identifier
text	S	0..1	string	Type of identifier
system		0..1	uri	System that issued the identifier (e.g. hospital, government)
value		1..1	string	Value of the identifier
identifier:personalNumber	S	1..1	Identifier	National personal number for the patient
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Required Pattern: PN
system		1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible)
value		1..1	string	Personal number value
active	S	0..1	boolean	Whether the patient record is active or not
name	SO	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
text	S	1..1	string	Full name of the patient
family		0..1	string	Family name of the patient often called 'surname / last name'
given		0..1	string	Given name of the patient often called 'first name'
Slices for telecom	O	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	S	0..1	ContactPoint	A contact detail for the individual
system		1..1	code	Patient phone number Required Pattern: phone
telecom:email	S	0..1	ContactPoint	A contact detail for the individual
system		1..1	code	Patient email address Required Pattern: email
birthDate	SO	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.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: no-id-requires-identifier
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	ID for the meta element
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version ID for the meta element
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	1..*	canonical(StructureDefinition)	Profile URL for WOF Connect Patient
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	1..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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Σ	1..1	uri	Identity of the terminology system Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/CodeSystem/pms-system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	System the data originates from
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
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	SO	1..*	Extension	Consent to receive marketing communication Obligations Actor SHOULD:populate https://serveractor.examplse.se
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of the consent to marketing communication extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SOΣ	1..*	Identifier	Identifier for the patient Slice: Unordered, Open by pattern:type.coding.code Obligations Actor SHOULD:populate https://serveractor.examplse.se
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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Coded type of the identifier
text	SΣ	0..1	string	Type of identifier
system	Σ	0..1	uri	System that issued the identifier (e.g. hospital, government) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Value of the identifier 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:personalNumber	SΣ	1..1	Identifier	National personal number for 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	?!Σ	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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	SΣ	1..*	Coding	Coded type of the identifier
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system Required Pattern: PN
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	0..1	string	Type of identifier
system	Σ	1..1	uri	System that issued the personal number Binding: Allowed Personal Number Identifier Systems (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Personal number value 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Σ	0..1	boolean	Whether the patient record is active or not
name	SOΣ	1..*	HumanName	Name of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
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	SΣ	1..1	string	Full name of the patient
family	Σ	0..1	string	Family name of the patient often called 'surname / last name'
given	Σ	0..1	string	Given name of the patient often called 'first name' This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
Slices for telecom	OΣ	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Obligations Actor SHOULD:populate-if-known https://serveractor.examplse.se
telecom:phone	SΣ	0..1	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	ΣC	1..1	code	Patient phone number Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
telecom:email	SΣ	0..1	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	ΣC	1..1	code	Patient email address Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SOΣ	1..1	date	Birth date of the patient Obligations Actor SHOULD:populate https://serveractor.examplse.se
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
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	?!Σ	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.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
Patient.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
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	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.identifier:personalNumber.​system	Base	extensible	Allowed Personal Number Identifier Systems	📦0.1.1	This IG
Patient.name.use	Base	required	NameUse	📍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.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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
no-id-requires-identifier	error	Patient	If id is missing, at least one identifier shall exist.	id.exists().not() implies identifier.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: 14 elements(4 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 1 element

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.telecom