ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: AppointmentBookerOnBehalfOf

The profile is used when the appointment booking has been made by a person acting on behalf of the customer.

Usages:

• Refer to this Profile: AppointmentProvenance and EraAppointmentProvenance
• CapabilityStatements using this Profile: ERA Capability Statement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id	Σ This element is included in summaries.	1..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.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
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value	Σ This element is included in summaries.	1..1	string	Finnish personal identity code Example General: 123456
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.patient.reference	Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.relationship	Σ This element is included in summaries.	1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.system	Σ This element is included in summaries.	1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.code	Σ This element is included in summaries.	1..1	code	Code of the role
RelatedPerson.relationship.coding.display	Σ This element is included in summaries.	1..1	string	Name of the role
RelatedPerson.name	Σ This element is included in summaries.	1..1	HumanName	Name details of the proxy
RelatedPerson.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
RelatedPerson.name.family	Σ This element is included in summaries.	1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given	Σ This element is included in summaries.	1..4	string	Given name of the person making the appointment booking This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id		1..1	id	Logical id of this artifact
RelatedPerson.meta		0..1	Meta	Metadata about the resource
RelatedPerson.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.identifier		1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.type		0..0		Description of identifier
RelatedPerson.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value		1..1	string	Finnish personal identity code
RelatedPerson.identifier.period		0..0		Time period when id is/was valid for use
RelatedPerson.identifier.assigner		0..0		Organization that issued id (may be just text)
RelatedPerson.active		0..0		Whether this related person's record is in active use
RelatedPerson.patient
RelatedPerson.patient.reference		1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.patient.type		0..0		Type the reference refers to (e.g. "Patient")
RelatedPerson.patient.identifier		0..0		Logical reference, when literal reference is not known
RelatedPerson.patient.display		0..0		Text alternative for the resource
RelatedPerson.relationship		1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.coding		1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.system		1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.version		0..0		Version of the system - if relevant
RelatedPerson.relationship.coding.code		1..1	code	Code of the role
RelatedPerson.relationship.coding.display		1..1	string	Name of the role
RelatedPerson.relationship.coding.userSelected		0..0		If this coding was chosen directly by the user
RelatedPerson.relationship.text		0..0		Plain text representation of the concept
RelatedPerson.name		1..1	HumanName	Name details of the proxy
RelatedPerson.name.id		0..0		Unique id for inter-element referencing
RelatedPerson.name.use		0..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed)
RelatedPerson.name.text		0..0		Text representation of the full name
RelatedPerson.name.family		1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given		1..4	string	Given name of the person making the appointment booking
RelatedPerson.name.prefix		0..0		Parts that come before the name
RelatedPerson.name.suffix		0..0		Parts that come after the name
RelatedPerson.name.period		0..0		Time period when name was/is in use
RelatedPerson.telecom		0..0		A contact detail for the person
RelatedPerson.gender		0..0		male | female | other | unknown
RelatedPerson.birthDate		0..0		The date on which the related person was born
RelatedPerson.address		0..0		Address where the related person can be contacted or visited
RelatedPerson.photo		0..0		Image of the person
RelatedPerson.period		0..0		Period of time that this relationship is considered valid
RelatedPerson.communication		0..0		A language which may be used to communicate with about the patient's health
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id	Σ This element is included in summaries.	1..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.meta.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
RelatedPerson.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
RelatedPerson.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
RelatedPerson.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
RelatedPerson.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
RelatedPerson.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
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.extension		0..*	Extension	Additional content defined by implementations
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value	Σ This element is included in summaries.	1..1	string	Finnish personal identity code Example General: 123456
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.patient.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.patient.reference	Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.relationship	Σ This element is included in summaries.	1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.relationship.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.relationship.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.relationship.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.relationship.coding.system	Σ This element is included in summaries.	1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.code	Σ This element is included in summaries.	1..1	code	Code of the role
RelatedPerson.relationship.coding.display	Σ This element is included in summaries.	1..1	string	Name of the role
RelatedPerson.name	Σ This element is included in summaries.	1..1	HumanName	Name details of the proxy
RelatedPerson.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
RelatedPerson.name.family	Σ This element is included in summaries.	1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given	Σ This element is included in summaries.	1..4	string	Given name of the person making the appointment booking This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
RelatedPerson.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from RelatedPerson

Summary

Mandatory: 14 elements(1 nested mandatory element)
Fixed: 5 elements
Prohibited: 22 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id	Σ This element is included in summaries.	1..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.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
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value	Σ This element is included in summaries.	1..1	string	Finnish personal identity code Example General: 123456
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.patient.reference	Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.relationship	Σ This element is included in summaries.	1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.system	Σ This element is included in summaries.	1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.code	Σ This element is included in summaries.	1..1	code	Code of the role
RelatedPerson.relationship.coding.display	Σ This element is included in summaries.	1..1	string	Name of the role
RelatedPerson.name	Σ This element is included in summaries.	1..1	HumanName	Name details of the proxy
RelatedPerson.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
RelatedPerson.name.family	Σ This element is included in summaries.	1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given	Σ This element is included in summaries.	1..4	string	Given name of the person making the appointment booking This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id		1..1	id	Logical id of this artifact
RelatedPerson.meta		0..1	Meta	Metadata about the resource
RelatedPerson.meta.profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.identifier		1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.type		0..0		Description of identifier
RelatedPerson.identifier.system		1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value		1..1	string	Finnish personal identity code
RelatedPerson.identifier.period		0..0		Time period when id is/was valid for use
RelatedPerson.identifier.assigner		0..0		Organization that issued id (may be just text)
RelatedPerson.active		0..0		Whether this related person's record is in active use
RelatedPerson.patient
RelatedPerson.patient.reference		1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.patient.type		0..0		Type the reference refers to (e.g. "Patient")
RelatedPerson.patient.identifier		0..0		Logical reference, when literal reference is not known
RelatedPerson.patient.display		0..0		Text alternative for the resource
RelatedPerson.relationship		1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.coding		1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.system		1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.version		0..0		Version of the system - if relevant
RelatedPerson.relationship.coding.code		1..1	code	Code of the role
RelatedPerson.relationship.coding.display		1..1	string	Name of the role
RelatedPerson.relationship.coding.userSelected		0..0		If this coding was chosen directly by the user
RelatedPerson.relationship.text		0..0		Plain text representation of the concept
RelatedPerson.name		1..1	HumanName	Name details of the proxy
RelatedPerson.name.id		0..0		Unique id for inter-element referencing
RelatedPerson.name.use		0..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed)
RelatedPerson.name.text		0..0		Text representation of the full name
RelatedPerson.name.family		1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given		1..4	string	Given name of the person making the appointment booking
RelatedPerson.name.prefix		0..0		Parts that come before the name
RelatedPerson.name.suffix		0..0		Parts that come after the name
RelatedPerson.name.period		0..0		Time period when name was/is in use
RelatedPerson.telecom		0..0		A contact detail for the person
RelatedPerson.gender		0..0		male | female | other | unknown
RelatedPerson.birthDate		0..0		The date on which the related person was born
RelatedPerson.address		0..0		Address where the related person can be contacted or visited
RelatedPerson.photo		0..0		Image of the person
RelatedPerson.period		0..0		Period of time that this relationship is considered valid
RelatedPerson.communication		0..0		A language which may be used to communicate with about the patient's health
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	Person who made the appointment booking on behalf of another person
RelatedPerson.id	Σ This element is included in summaries.	1..1	id	Logical id of this artifact
RelatedPerson.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
RelatedPerson.meta.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.meta.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.meta.versionId	Σ This element is included in summaries.	0..1	id	Version specific identifier
RelatedPerson.meta.lastUpdated	Σ This element is included in summaries.	0..1	instant	When the resource version last changed
RelatedPerson.meta.source	Σ This element is included in summaries.	0..1	uri	Identifies where the resource comes from
RelatedPerson.meta.profile	Σ This element is included in summaries.	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to Fixed Value: https://pta.kanta.fi/fhir/StructureDefinition/AppointmentBookerOnBehalfOf (no extensions allowed)
RelatedPerson.meta.security	Σ This element is included in summaries.	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
RelatedPerson.meta.tag	Σ This element is included in summaries.	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
RelatedPerson.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
RelatedPerson.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained		0..*	Resource	Contained, inline Resources
RelatedPerson.extension		0..*	Extension	Additional content defined by implementations
RelatedPerson.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
RelatedPerson.identifier	Σ This element is included in summaries.	1..1	Identifier	Finnish personal identity code of the person making the appointment booking
RelatedPerson.identifier.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: official (no extensions allowed)
RelatedPerson.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.246.21 (no extensions allowed)
RelatedPerson.identifier.value	Σ This element is included in summaries.	1..1	string	Finnish personal identity code Example General: 123456
RelatedPerson.patient	Σ This element is included in summaries.	1..1	Reference(Patient)	The patient this person is related to
RelatedPerson.patient.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.patient.reference	Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
RelatedPerson.relationship	Σ This element is included in summaries.	1..1	CodeableConcept	Role of the related person Binding: fipta-vs-relatedpersonrole (required)
RelatedPerson.relationship.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.relationship.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.relationship.coding	Σ This element is included in summaries.	1..1	Coding	Code defined by a terminology system
RelatedPerson.relationship.coding.id		0..1	string	Unique id for inter-element referencing
RelatedPerson.relationship.coding.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.relationship.coding.system	Σ This element is included in summaries.	1..1	uri	Identifier of the Value Set code system Fixed Value: urn:oid:1.2.246.537.6.882.201501 (no extensions allowed)
RelatedPerson.relationship.coding.code	Σ This element is included in summaries.	1..1	code	Code of the role
RelatedPerson.relationship.coding.display	Σ This element is included in summaries.	1..1	string	Name of the role
RelatedPerson.name	Σ This element is included in summaries.	1..1	HumanName	Name details of the proxy
RelatedPerson.name.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
RelatedPerson.name.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
RelatedPerson.name.family	Σ This element is included in summaries.	1..1	string	Family name of the person making the appointment booking
RelatedPerson.name.given	Σ This element is included in summaries.	1..4	string	Given name of the person making the appointment booking This repeating element order: Given Names appear in the correct order for presenting the name
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
RelatedPerson.meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
RelatedPerson.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
RelatedPerson.identifier.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
RelatedPerson.relationship	Base	required	fipta-vs-relatedpersonrole	📦1.0.0	This IG
RelatedPerson.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from RelatedPerson

Summary

Mandatory: 14 elements(1 nested mandatory element)
Fixed: 5 elements
Prohibited: 22 elements

Other representations of profile: CSV, Excel, Schematron