PLUGIN - Local Development build (v0.1.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: PluginPatient

Describes the Patient resource as used by the Dutch PLUGIN project. Inherits from nl-core-Patient.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from NlcorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
identifier	S	1..*	Identifier	PatientIdentificationNumber
active		0..1	boolean	Whether this patient's record is in active use Required Pattern: true
name	S	1..*	HumanName	NameInformation / PayerName
gender	S	1..1	code	Gender
birthDate	S	1..1	date	DateOfBirth
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
address	S	1..*	NlcoreAddressInformation	AddressInformation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
nationality	N	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:code	N	0..1	Extension	Nationality Code
extension	N	0..0
url		1..1	uri	"code"
value[x]	N	1..1	CodeableConcept	Nationality Binding: NationaliteitCodelijst (extensible)
extension:period	N	0..1	Extension	Nationality Period
extension	N	0..0
url		1..1	uri	"period"
value[x]	N	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	PatientIdentificationNumber Slice: Unordered, Open by value:$this
identifier:bsn	ΣN	0..*	Identifier	An identifier for this patient Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Required Pattern: true
Slices for name	SΣ	1..*	HumanName	NameInformation / PayerName Slice: Unordered, Open by value:use
name:nameInformation	ΣCN	0..2	NlcoreNameInformation	NameInformation
name:nameInformation-GivenName	ΣN	0..*	NlcoreNameInformationGivenName	Name of a human - parts and usage
Slices for telecom	ΣCN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	ΣCN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	ΣCN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
gender	SΣ	1..1	code	Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
genderCodelist	N	0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
birthDate	SΣ	1..1	date	DateOfBirth
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	DeathIndicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	DateOfDeath
address	SΣ	1..*	NlcoreAddressInformation	AddressInformation
Slices for multipleBirth[x]	N	0..1		Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean	N	0..1	boolean	MultipleBirthIndicator
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	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.extension:nationality.extension:code.value[x]	extensible	NationaliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses	A system is required if a value is provided. : value.empty() or system.exists()
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()
ref-1	error	Patient.link.other	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1	error	Patient.name:nameInformation	If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2	error	Patient.name:nameInformation	If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nationality	N	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	N	0..1	Extension	Nationality Code
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"code"
value[x]	N	1..1	CodeableConcept	Nationality Binding: NationaliteitCodelijst (extensible)
extension:period	N	0..1	Extension	Nationality Period
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"period"
value[x]	N	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	PatientIdentificationNumber Slice: Unordered, Open by value:$this
identifier:bsn	ΣN	0..*	Identifier	An identifier for this patient Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
value		0..1	string	The value that is unique
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	?!Σ	0..1	boolean	Whether this patient's record is in active use Required Pattern: true
Slices for name	SΣ	1..*	HumanName	NameInformation / PayerName Slice: Unordered, Open by value:use
name:nameInformation	ΣCN	0..2	NlcoreNameInformation	NameInformation
name:nameInformation-GivenName	ΣN	0..*	NlcoreNameInformationGivenName	Name of a human - parts and usage
Slices for telecom	ΣCN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	ΣCN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	ΣCN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
gender	SΣ	1..1	code	Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
genderCodelist	N	0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
value[x]	N	0..1	CodeableConcept	Gender Binding: GeslachtCodelijst (required): GeslachtCodelijst
value		0..1	code	Primitive value for code Max Length: 1048576
birthDate	SΣ	1..1	date	DateOfBirth
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	DeathIndicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	DateOfDeath
address	SΣ	1..*	NlcoreAddressInformation	AddressInformation
maritalStatus		0..1	CodeableConcept	MaritalStatus Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst
Slices for multipleBirth[x]	N	0..1		Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean	N	0..1	boolean	MultipleBirthIndicator
photo	C	0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	Contact
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactPerson	N	0..1	Reference(RelatedPerson)	This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
value[x]	N	1..1	Reference(RelatedPerson | nl core ContactPerson)	Contact
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for relationship	N	0..*	CodeableConcept	The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
relationship:role	N	0..*	CodeableConcept	Role Binding: RolCodelijst (required): RolCodelijst
relationship:relationship	N	0..*	CodeableConcept	Relationship Binding: RelatieCodelijst (required): RelatieCodelijst
name	C	0..1	NlcoreNameInformation	NameInformation
Slices for telecom	CN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	CN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	CN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
address		0..1	NlcoreAddressInformation	AddressInformation
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	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	LanguageProficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
languageControl	N	0..*	(Complex)	LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	2..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	1..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"level"
value[x]	N	1..1	Coding	Value of extension Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.
extension:type	N	1..1	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"type"
value[x]	N	1..1	Coding	Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
communicationDetails	N	0..*	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: CommunicatieBijzonderhedenCodelijst (extensible)
comment	N	0..1	string	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
value[x]	N	0..1	string	Comment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	CommunicationLanguage Binding: CommunicatieTaalCodelijst (required): CommunicatieTaalCodelijst Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	PatternNlCoreHealthProfessionalReference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole)	A reference from one resource to another
managingOrganization	ΣC	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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:nationality.extension:code.value[x]	extensible	NationaliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.gender.extension:genderCodelist.value[x]	required	GeslachtCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
Patient.maritalStatus	required	BurgerlijkeStaatCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.relationship:role	required	RolCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
Patient.contact.relationship:relationship	required	RelatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.extension:languageControl.extension:level.value[x]	required	LanguageAbilityProficiency http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:languageControl.extension:type.value[x]	preferred	LanguageAbilityMode http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.language	required	CommunicatieTaalCodelijst Additional Bindings Purpose AllLanguages Max Binding http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1	error	Patient.contact.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1	error	Patient.name:nameInformation, Patient.contact.name	If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2	error	Patient.name:nameInformation, Patient.contact.name	If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcorePatient

Summary

Mandatory: 5 elements
Must-Support: 6 elements

Differential View

This structure is derived from NlcorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
identifier	S	1..*	Identifier	PatientIdentificationNumber
active		0..1	boolean	Whether this patient's record is in active use Required Pattern: true
name	S	1..*	HumanName	NameInformation / PayerName
gender	S	1..1	code	Gender
birthDate	S	1..1	date	DateOfBirth
deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not
address	S	1..*	NlcoreAddressInformation	AddressInformation
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
nationality	N	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
extension:code	N	0..1	Extension	Nationality Code
extension	N	0..0
url		1..1	uri	"code"
value[x]	N	1..1	CodeableConcept	Nationality Binding: NationaliteitCodelijst (extensible)
extension:period	N	0..1	Extension	Nationality Period
extension	N	0..0
url		1..1	uri	"period"
value[x]	N	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	PatientIdentificationNumber Slice: Unordered, Open by value:$this
identifier:bsn	ΣN	0..*	Identifier	An identifier for this patient Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
active	?!Σ	0..1	boolean	Whether this patient's record is in active use Required Pattern: true
Slices for name	SΣ	1..*	HumanName	NameInformation / PayerName Slice: Unordered, Open by value:use
name:nameInformation	ΣCN	0..2	NlcoreNameInformation	NameInformation
name:nameInformation-GivenName	ΣN	0..*	NlcoreNameInformationGivenName	Name of a human - parts and usage
Slices for telecom	ΣCN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	ΣCN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	ΣCN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
gender	SΣ	1..1	code	Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
genderCodelist	N	0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
birthDate	SΣ	1..1	date	DateOfBirth
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	DeathIndicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	DateOfDeath
address	SΣ	1..*	NlcoreAddressInformation	AddressInformation
Slices for multipleBirth[x]	N	0..1		Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean	N	0..1	boolean	MultipleBirthIndicator
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	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.extension:nationality.extension:code.value[x]	extensible	NationaliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cpt-2	error	Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses	A system is required if a value is provided. : value.empty() or system.exists()
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()
ref-1	error	Patient.link.other	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1	error	Patient.name:nameInformation	If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2	error	Patient.name:nameInformation	If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	NlcorePatient	Patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nationality	N	0..1	(Complex)	Nationality URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	N	0..1	Extension	Nationality Code
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"code"
value[x]	N	1..1	CodeableConcept	Nationality Binding: NationaliteitCodelijst (extensible)
extension:period	N	0..1	Extension	Nationality Period
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"period"
value[x]	N	1..1	Period	Value of extension
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-nationality"
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	PatientIdentificationNumber Slice: Unordered, Open by value:$this
identifier:bsn	ΣN	0..*	Identifier	An identifier for this patient Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual | official | temp | secondary | old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/bsn
value		0..1	string	The value that is unique
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	?!Σ	0..1	boolean	Whether this patient's record is in active use Required Pattern: true
Slices for name	SΣ	1..*	HumanName	NameInformation / PayerName Slice: Unordered, Open by value:use
name:nameInformation	ΣCN	0..2	NlcoreNameInformation	NameInformation
name:nameInformation-GivenName	ΣN	0..*	NlcoreNameInformationGivenName	Name of a human - parts and usage
Slices for telecom	ΣCN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	ΣCN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	ΣCN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
gender	SΣ	1..1	code	Gender Binding: AdministrativeGender (required): Use ConceptMap GeslachtCodelijst-to-AdministrativeGender to translate terminology from the functional model to profile terminology in ValueSet AdministrativeGender.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
genderCodelist	N	0..1	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
value[x]	N	0..1	CodeableConcept	Gender Binding: GeslachtCodelijst (required): GeslachtCodelijst
value		0..1	code	Primitive value for code Max Length: 1048576
birthDate	SΣ	1..1	date	DateOfBirth
Slices for deceased[x]	?!SΣ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	DeathIndicator
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	DateOfDeath
address	SΣ	1..*	NlcoreAddressInformation	AddressInformation
maritalStatus		0..1	CodeableConcept	MaritalStatus Binding: BurgerlijkeStaatCodelijst (required): BurgerlijkeStaatCodelijst
Slices for multipleBirth[x]	N	0..1		Whether patient is part of a multiple birth Slice: Unordered, Open by type:$this
multipleBirthBoolean			boolean
multipleBirthInteger			integer
multipleBirth[x]:multipleBirthBoolean	N	0..1	boolean	MultipleBirthIndicator
photo	C	0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	Contact
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactPerson	N	0..1	Reference(RelatedPerson)	This contact may have further details in this RelatedPerson URL: http://hl7.org/fhir/StructureDefinition/patient-relatedPerson
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-relatedPerson"
value[x]	N	1..1	Reference(RelatedPerson | nl core ContactPerson)	Contact
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for relationship	N	0..*	CodeableConcept	The kind of relationship Slice: Unordered, Open by value:$this Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
relationship:role	N	0..*	CodeableConcept	Role Binding: RolCodelijst (required): RolCodelijst
relationship:relationship	N	0..*	CodeableConcept	Relationship Binding: RelatieCodelijst (required): RelatieCodelijst
name	C	0..1	NlcoreNameInformation	NameInformation
Slices for telecom	CN	0..*	ContactPoint	ContactInformation Slice: Unordered, Open by profile:$this
telecom:telephoneNumbers	CN	0..*	NlcoreContactInformationTelephoneNumbers	TelephoneNumbers
telecom:emailAddresses	CN	0..*	NlcoreContactInformationEmailAddresses	EmailAddresses
address		0..1	NlcoreAddressInformation	AddressInformation
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	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	LanguageProficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
languageControl	N	0..*	(Complex)	LanguageControlListening / LanguageControlSpeaking / LanguageControlReading URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	2..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	1..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"level"
value[x]	N	1..1	Coding	Value of extension Binding: LanguageAbilityProficiency (required): The proficiency level for the communication.
extension:type	N	1..1	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"type"
value[x]	N	1..1	Coding	Value of extension Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
communicationDetails	N	0..*	CodeableConcept	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-LanguageProficiency.CommunicationDetails Binding: CommunicatieBijzonderhedenCodelijst (extensible)
comment	N	0..1	string	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
value[x]	N	0..1	string	Comment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	CommunicationLanguage Binding: CommunicatieTaalCodelijst (required): CommunicatieTaalCodelijst Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	PatternNlCoreHealthProfessionalReference(Organization | Practitioner | PractitionerRole | nl core HealthProfessional PractitionerRole)	A reference from one resource to another
managingOrganization	ΣC	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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:nationality.extension:code.value[x]	extensible	NationaliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.6.3--20200901000000
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.gender.extension:genderCodelist.value[x]	required	GeslachtCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.0.1.1--20200901000000
Patient.maritalStatus	required	BurgerlijkeStaatCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.9.1--20200901000000
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.relationship:role	required	RolCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.2--20200901000000
Patient.contact.relationship:relationship	required	RelatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.1.1--20200901000000
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.extension:languageControl.extension:level.value[x]	required	LanguageAbilityProficiency http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:languageControl.extension:type.value[x]	preferred	LanguageAbilityMode http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.language	required	CommunicatieTaalCodelijst Additional Bindings Purpose AllLanguages Max Binding http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.7.12.2--20200901000000
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.telecom:telephoneNumbers, Patient.telecom:emailAddresses, Patient.contact.telecom, Patient.contact.telecom:telephoneNumbers, Patient.contact.telecom:emailAddresses	A system is required if a value is provided. : value.empty() or system.exists()
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
per-1	error	Patient.contact.period	If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
zib-NameInformation-1	error	Patient.name:nameInformation, Patient.contact.name	If a prefix for a family name is specified, the family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2	error	Patient.name:nameInformation, Patient.contact.name	If the prefix for a partner family name is specified, the partner family name is expected as well : family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

This structure is derived from NlcorePatient

Summary

Mandatory: 5 elements
Must-Support: 6 elements

Other representations of profile: CSV, Excel, Schematron