GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions

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

Resource Profile: DVC Patient with Selective Disclosure

DVC Patient with Selective Disclosure

Usages:

• Use this Profile: DVC document Bundle with Selective Disclosure
• Refer to this Profile: Digital Vaccination Certificate - Composition

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..*	DVCPatient	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nationality	S This element must be supported.	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use, exists:text Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:dvcName	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.Slices for name.name:dvcName.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official (extensions allowed)
Patient.Slices for name.name:dvcName.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.contact	S This element must be supported. C	0..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.name:dvcName.​use	Base	required	NameUse	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from DVCPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			DVCPatient
Patient.text
Patient.text.Slices for extension				Content/Rules for all slices
Patient.text.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	DVCPatient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.text.id		0..1	id	Unique id for inter-element referencing
Patient.text.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.text.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.text.status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
Patient.text.div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality	S This element must be supported.	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	id	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use, exists:text Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:dvcName	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.Slices for name.name:dvcName.id		0..1	id	Unique id for inter-element referencing
Patient.Slices for name.name:dvcName.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:dvcName.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official (extensions allowed)
Patient.Slices for name.name:dvcName.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.Slices for name.name:dvcName.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:dvcName.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	S This element must be supported. C	0..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: Relationship Status for Contact in Patient (required)
Patient.contact.name	C	0..1	HumanName	A name associated with the contact person
Patient.contact.telecom	C	0..*	ContactPoint	A contact detail for the person
Patient.contact.address	C	0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.text.status	Base	required	NarrativeStatus	📍5.0.0	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.name:dvcName.​use	Base	required	NameUse	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.maritalStatus	Base	extensible	Marital Status Codes	📍5.0.0	FHIR Std.
Patient.contact.relationship	Base	required	Relationship Status for Contact in Patient	📦0.1.0	This IG
Patient.contact.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
txt-1	error	Patient.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	Patient.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from DVCPatient

Summary

Extensions

This structure refers to these extensions:

• http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	DVCPatient	Information about an individual or animal receiving health care services
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:nationality	S This element must be supported.	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use, exists:text Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:dvcName	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.Slices for name.name:dvcName.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official (extensions allowed)
Patient.Slices for name.name:dvcName.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.contact	S This element must be supported. C	0..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.name:dvcName.​use	Base	required	NameUse	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from DVCPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			DVCPatient
Patient.text
Patient.text.Slices for extension				Content/Rules for all slices
Patient.text.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	DVCPatient	Information about an individual or animal receiving health care services
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.text.id		0..1	id	Unique id for inter-element referencing
Patient.text.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.text.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.text.status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
Patient.text.div	C	1..1	xhtml	Limited xhtml content Constraints: txt-1, txt-2
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:nationality	S This element must be supported.	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
Patient.Slices for extension.extension:SelectiveDisclosure		0..1	code	Extension URL: http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure
Patient.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Patient.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	An identifier for this patient
Patient.identifier.id		0..1	id	Unique id for inter-element referencing
Patient.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type	Σ This element is included in summaries.	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Patient.identifier.system	S This element must be supported. Σ This element is included in summaries.	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value	S This element must be supported. Σ This element is included in summaries. C	0..1	string	The value that is unique Example General: 123456
Patient.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.identifier.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use, exists:text Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:dvcName	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient
Patient.Slices for name.name:dvcName.id		0..1	id	Unique id for inter-element referencing
Patient.Slices for name.name:dvcName.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:dvcName.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Required Pattern: official (extensions allowed)
Patient.Slices for name.name:dvcName.text	S This element must be supported. Σ This element is included in summaries.	1..1	string	Text representation of the full name
Patient.Slices for name.name:dvcName.family	Σ This element is included in summaries.	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:dvcName.given	Σ This element is included in summaries.	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:dvcName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.gender	Σ This element is included in summaries.	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	1..1	date	The date of birth for the individual
Patient.deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean			boolean
Patient.deceased[x].deceasedDateTime			dateTime
Patient.address	Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		Whether patient is part of a multiple birth
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	S This element must be supported. C	0..1	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: Relationship Status for Contact in Patient (required)
Patient.contact.name	C	0..1	HumanName	A name associated with the contact person
Patient.contact.telecom	C	0..*	ContactPoint	A contact detail for the person
Patient.contact.address	C	0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to a Patient or RelatedPerson resource that concerns the same actual individual
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Patient.language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.text.status	Base	required	NarrativeStatus	📍5.0.0	FHIR Std.
Patient.identifier.use	Base	required	IdentifierUse	📍5.0.0	FHIR Std.
Patient.identifier.type	Base	extensible	Identifier Type Codes	📍5.0.0	FHIR Std.
Patient.name:dvcName.​use	Base	required	NameUse	📍5.0.0	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.maritalStatus	Base	extensible	Marital Status Codes	📍5.0.0	FHIR Std.
Patient.contact.relationship	Base	required	Relationship Status for Contact in Patient	📦0.1.0	This IG
Patient.contact.gender	Base	required	AdministrativeGender	📍5.0.0	FHIR Std.
Patient.communication.​language	Base	required	All Languages	📍5.0.0	FHIR Std.
Patient.link.type	Base	required	Link Type	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization	name.exists() or telecom.exists() or address.exists() or organization.exists()
txt-1	error	Patient.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes	htmlChecks()
txt-2	error	Patient.text.div	The narrative SHALL have some non-whitespace content	htmlChecks()

This structure is derived from DVCPatient

Summary

Extensions

This structure refers to these extensions:

• http://smart.who.int/trust-phw/StructureDefinition/SelectiveDisclosure

Other representations of profile: CSV, Excel, Schematron