RareLink Implementation Guide - Local Development build (v2.0.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: RareLink IPS Patient

A RareLink-specific profile for the IPS Patient resource.

Usages:

• Refer to this Profile: RareLink Condition for Undiagnosed RD Case, RareLink Consent, RareLink Encounter, RareLink Family History... Show 11 more, RareLink Genetic Variant Observation, RareLink IPS Condition, RareLink IPS Measurement Laboratory, RareLink IPS Measurement Radiology, RareLink IPS Procedure, RareLink Observation Karyotypic Sex, RareLink Observation Age Category, RareLink Observation Gestation at Birth, RareLink Observation Measurements (Others), RareLink Vital Signs Measurements and RareLink Observation Phenotypic Feature

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.

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

This structure is derived from PatientUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			PatientUvIps
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
code		0..1	code	Symbol in syntax defined by the system Required Pattern: 422549004
value	S	0..1	string	The value that is unique
name
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Required Pattern: unknown
Slices for deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean	S	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	S	0..1	dateTime	Indicates if the individual is deceased or not
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
value	SΣ	0..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: unknown
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
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	?!SΣ	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
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	Conformance	ValueSet / Code	URI
Patient.identifier.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Pattern Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	An identifier for this 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 . Required Pattern: official
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	Σ	0..*	Coding	Code defined by a terminology system
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://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: 422549004
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique 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	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: unknown
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
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	?!SΣ	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	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..*	CodeableConceptIPS	Concept - reference to a terminology or just text 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	S	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Pattern Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.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 PatientUvIps

Summary

Must-Support: 5 elements

Extensions

This structure refers to these extensions:

• https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
• https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
• https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
• https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
• https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status
• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from PatientUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			PatientUvIps
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://snomed.info/sct
code		0..1	code	Symbol in syntax defined by the system Required Pattern: 422549004
value	S	0..1	string	The value that is unique
name
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x]		1..1	code	Value of extension Required Pattern: unknown
Slices for deceased[x]	S	0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceased[x]:deceasedBoolean	S	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	S	0..1	dateTime	Indicates if the individual is deceased or not
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
value	SΣ	0..1	string	The value that is unique Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: unknown
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
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	?!SΣ	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	0..*	Address	An address for the individual
generalPractitioner	S	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
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	Conformance	ValueSet / Code	URI
Patient.identifier.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Pattern Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	PatientUvIps	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birth_place		0..1	CodeableConcept	Birth Place URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
extension:date_of_admission		0..1	dateTime	Date of Admission URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
extension:recorded_sex_at_birth		0..1	CodeableConcept	Recorded Sex at Birth URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
extension:cause_of_death		0..1	(Complex)	Cause of Death URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
extension:vital_status	S	0..1	CodeableConcept	Vital Status URL: https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status Binding: Vital Status Value Set (extensible)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	An identifier for this 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 . Required Pattern: official
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	Σ	0..*	Coding	Code defined by a terminology system
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://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: 422549004
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique 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	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient Constraints: ips-pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	(Complex)	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x]		1..1	code	Value of extension Binding: DataAbsentReason (required) Required Pattern: unknown
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	SΣ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	1..1	date	The date of birth for the individual
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	?!SΣ	0..1	boolean	Indicates if the individual is deceased or not
deceased[x]:deceasedDateTime	?!SΣ	0..1	dateTime	Indicates if the individual is deceased or not
address	SΣ	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..*	CodeableConceptIPS	Concept - reference to a terminology or just text 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	S	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	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]	required	Pattern Value: unknown http://hl7.org/fhir/ValueSet/data-absent-reason From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ips-pat-1	error	Patient.name	Patient.name.given, Patient.name.family or Patient.name.text SHALL be present : family.exists() or given.exists() or text.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 PatientUvIps

Summary

Must-Support: 5 elements

Extensions

This structure refers to these extensions:

• https://rarelink.bih-charite.de/fhir/StructureDefinition/birth-place
• https://rarelink.bih-charite.de/fhir/StructureDefinition/date-of-admission
• https://rarelink.bih-charite.de/fhir/StructureDefinition/recorded-sex-at-birth
• https://rarelink.bih-charite.de/fhir/StructureDefinition/cause-of-death
• https://rarelink.bih-charite.de/fhir/StructureDefinition/vital-status
• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron