This page is part of the Interoperability of Clic Santé (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: Appointment Patient ( Experimental )

A patient specifically linked to an appointment that aligns with Clic Sante's Systems.

Usage:

• Refer to this Resource Profile: Appointment
• Examples for this Resource Profile: Patient/65455b44-591e-420a-a34a-1e0d48e50b44

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
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	Σ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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()

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title
modifierExtension		0..0
name		1..*	HumanName	A name associated with the patient
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
deceased[x]		0..0
address		0..0
photo		0..0
link		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	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
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title
identifier	Σ	0..*	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth 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
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 3 elements
Prohibited: 6 elements

Extensions

This structure refers to these extensions:

• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
name	Σ	1..*	HumanName	A name associated with the patient ele-1: All FHIR elements must have a @value or children
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children
birthDate	Σ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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()

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	Information about an individual or animal receiving health care services
implicitRules		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title
modifierExtension		0..0
name		1..*	HumanName	A name associated with the patient
gender		1..1	code	male | female | other | unknown
birthDate		1..1	date	The date of birth for the individual
deceased[x]		0..0
address		0..0
photo		0..0
link		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Patient	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
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
occupation		0..1	string	Current patient's occupation (job) URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
unknownMother		0..1	boolean	Whether the patient's mother is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
unknownFather		0..1	boolean	Whether the patient's father is unknown URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
profileNumber		0..1	string	Profile number associated to the patient URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
schoolName		0..1	string	Name of the school the patient is attending URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
schoolClass		0..1	string	Class the patient is attending when the appointment occurs URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
commPhoneOnly		0..1	boolean	Whether the patient requested to be contacted by phone only URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
region		0..1	string	Region where the patient is located URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
employerName		0..1	string	The patient's current employer URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
employeeNumber		0..1	string	The patient's employee number URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
employeeCategory		0..1	string	The patient's employee category URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
employeeEstablishment		0..1	string	The patient's employee establishment URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
employeeJobTitle		0..1	string	The patient's job title as an employee URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title
identifier	Σ	0..*	Identifier	An identifier for this patient
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..*	HumanName	A name associated with the patient
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
gender	Σ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	1..1	date	The date of birth 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
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
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()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from Patient

Summary

Mandatory: 3 elements
Prohibited: 6 elements

Extensions

This structure refers to these extensions:

• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-occupation
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-mother
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-unknown-father
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-profile-number
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-name
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-school-class
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-comm-phone-only
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-region
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employer-name
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-number
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-category
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-establishment
• http://documentation.clicsante.ca/fhir/base/StructureDefinition/patient-employee-job-title

Other representations of profile: CSV, Excel, Schematron