BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI Canada flag

BC Client Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: PatientByExample

Official URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-patient-by-example Version: 1.0.0
Active as of 2026-03-25 Computable Name: PatientByExample

Will get removed. General constraints on the Patient resource for use in the BC Client Registry project for queries. PatientByExample is a resource of the Client Registry FHIR implementation use only by Get Demographics and Find Candidates

Usages:

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

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... Slices for extension Content/Rules for all slices
.... extension:aboriginalidentitygroup N 0..1 Coding Extension: Aboriginal Identity Group
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentitygroup
Binding: Aboriginal Identity Group (preferred): One of aboriginal identity codes
.... extension:aboriginalidentityindicator N 0..1 Coding Extension: Aboriginal Identity Indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentityindicator
Binding: Aboriginal Identity Indicator (preferred): One of self-reported codes identity as an aboriginal person
.... extension:birthsex N 0..1 Coding Extension: Sex at Birth
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Birth Sex (example): Code for sex assigned at birth
.... extension:ethnicity N 0..1 Coding Extension: ethnicity extension
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity
Binding: EthnicityCode (preferred): One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality.
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 0..1 IdentifierCABaseline An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:JHN Σ 0..1 IdentifierCABaseline Jurisdictional Health Number
..... Slices for extension Content/Rules for all slices
...... extension:versionCode N 0..1 string Health Number Version Code
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
....... 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 Σ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... use ?!Σ 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
... telecom SΣC 0..2 ContactPoint A contact detail for the individual
Constraints: cpt-2
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:preferred N 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension:noFixedAddress N 0..1 boolean No Fixed Address indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:JHN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:JHN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipa-pat-2 error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ref-1 error Patient.contact.organization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from PatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... contained 0..0 Contained, inline Resources
... Slices for identifier Content/Rules for all slices
.... identifier:JHN 0..1 IdentifierCABaseline Jurisdictional Health Number
... active 0..0 Whether this patient's record is in active use
... name 0..1 HumanName A name associated with the patient
.... use 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
... telecom S 0..2 ContactPoint A contact detail for the individual
... gender S 0..1 code male | female | other | unknown
... Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedDateTime S 0..1 dateTime Indicates if the individual is deceased or not
... address S 0..1 Address An address for the individual
.... type 0..1 code postal | physical
... maritalStatus 0..0 Marital (civil) status of a patient
... multipleBirth[x] 0..0 Whether patient is part of a multiple birth
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... communication 0..0 A language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..0 Patient's nominated primary care provider
... managingOrganization 0..0 Organization that is the custodian of the patient record
... link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
.... extension:aboriginalidentitygroup N 0..1 Coding Extension: Aboriginal Identity Group
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentitygroup
Binding: Aboriginal Identity Group (preferred): One of aboriginal identity codes
.... extension:aboriginalidentityindicator N 0..1 Coding Extension: Aboriginal Identity Indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentityindicator
Binding: Aboriginal Identity Indicator (preferred): One of self-reported codes identity as an aboriginal person
.... extension:birthsex N 0..1 Coding Extension: Sex at Birth
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Birth Sex (example): Code for sex assigned at birth
.... extension:ethnicity N 0..1 Coding Extension: ethnicity extension
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity
Binding: EthnicityCode (preferred): One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality.
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 0..1 IdentifierCABaseline An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:JHN Σ 0..1 IdentifierCABaseline Jurisdictional Health Number
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:versionCode N 0..1 string Health Number Version Code
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
....... 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 Σ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... name SΣC 0..1 HumanName A name associated with the patient
Constraints: ipa-pat-2
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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 ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom SΣC 0..2 ContactPoint A contact detail for the individual
Constraints: cpt-2
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:preferred N 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension:noFixedAddress N 0..1 boolean No Fixed Address indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:JHN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:JHN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipa-pat-2 error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
per-1 error Patient.identifier:JHN.period, Patient.name.period, Patient.telecom.period, Patient.address.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:JHN.assigner, Patient.contact.organization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from PatientProfile

Summary

Must-Support: 5 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... Slices for extension Content/Rules for all slices
.... extension:aboriginalidentitygroup N 0..1 Coding Extension: Aboriginal Identity Group
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentitygroup
Binding: Aboriginal Identity Group (preferred): One of aboriginal identity codes
.... extension:aboriginalidentityindicator N 0..1 Coding Extension: Aboriginal Identity Indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentityindicator
Binding: Aboriginal Identity Indicator (preferred): One of self-reported codes identity as an aboriginal person
.... extension:birthsex N 0..1 Coding Extension: Sex at Birth
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Birth Sex (example): Code for sex assigned at birth
.... extension:ethnicity N 0..1 Coding Extension: ethnicity extension
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity
Binding: EthnicityCode (preferred): One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality.
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 0..1 IdentifierCABaseline An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:JHN Σ 0..1 IdentifierCABaseline Jurisdictional Health Number
..... Slices for extension Content/Rules for all slices
...... extension:versionCode N 0..1 string Health Number Version Code
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
....... 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 Σ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... use ?!Σ 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
... telecom SΣC 0..2 ContactPoint A contact detail for the individual
Constraints: cpt-2
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:preferred N 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension:noFixedAddress N 0..1 boolean No Fixed Address indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:JHN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:JHN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipa-pat-2 error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ref-1 error Patient.contact.organization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from PatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... contained 0..0 Contained, inline Resources
... Slices for identifier Content/Rules for all slices
.... identifier:JHN 0..1 IdentifierCABaseline Jurisdictional Health Number
... active 0..0 Whether this patient's record is in active use
... name 0..1 HumanName A name associated with the patient
.... use 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
... telecom S 0..2 ContactPoint A contact detail for the individual
... gender S 0..1 code male | female | other | unknown
... Slices for deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedDateTime S 0..1 dateTime Indicates if the individual is deceased or not
... address S 0..1 Address An address for the individual
.... type 0..1 code postal | physical
... maritalStatus 0..0 Marital (civil) status of a patient
... multipleBirth[x] 0..0 Whether patient is part of a multiple birth
... photo 0..0 Image of the patient
... contact 0..0 A contact party (e.g. guardian, partner, friend) for the patient
... communication 0..0 A language which may be used to communicate with the patient about his or her health
... generalPractitioner 0..0 Patient's nominated primary care provider
... managingOrganization 0..0 Organization that is the custodian of the patient record
... link 0..0 Link to another patient resource that concerns the same actual person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientProfile Patient Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
.... extension:aboriginalidentitygroup N 0..1 Coding Extension: Aboriginal Identity Group
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentitygroup
Binding: Aboriginal Identity Group (preferred): One of aboriginal identity codes
.... extension:aboriginalidentityindicator N 0..1 Coding Extension: Aboriginal Identity Indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-aboriginalidentityindicator
Binding: Aboriginal Identity Indicator (preferred): One of self-reported codes identity as an aboriginal person
.... extension:birthsex N 0..1 Coding Extension: Sex at Birth
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Birth Sex (example): Code for sex assigned at birth
.... extension:ethnicity N 0..1 Coding Extension: ethnicity extension
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-ethnicity
Binding: EthnicityCode (preferred): One of self-reported ethnic group codes representing the ethnicity concept and should not be confused with citizenship or nationality.
... modifierExtension ?!N 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... Slices for identifier SΣ 0..1 IdentifierCABaseline An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:JHN Σ 0..1 IdentifierCABaseline Jurisdictional Health Number
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:versionCode N 0..1 string Health Number Version Code
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
....... 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 Σ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
..... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
... name SΣC 0..1 HumanName A name associated with the patient
Constraints: ipa-pat-2
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | nickname
Binding: BC Name Use value set. (required)
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 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 ΣC 0..1 Period Time period when name was/is in use
Constraints: per-1
... telecom SΣC 0..2 ContactPoint A contact detail for the individual
Constraints: cpt-2
.... id 0..1 string Unique id for inter-element referencing
.... extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value Σ 1..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period ΣC 0..1 Period Time period when the contact point was/is in use
Constraints: per-1
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣ 0..1 dateTime Indicates if the individual is deceased or not
... address SΣ 0..1 Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension N 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:preferred N 0..1 boolean HL7 Preferred Address Flag extension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... extension:noFixedAddress N 0..1 boolean No Fixed Address indicator
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period ΣC 0..1 Period Time period when address was/is in use
Constraints: per-1
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier:JHN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:JHN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required BC Name Use value set. 📦1.0.0 This IG
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error Patient.telecom, Patient.contact.telecom A system is required if a value is provided. value.empty() or system.exists()
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ipa-pat-2 error Patient.name Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. (family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
per-1 error Patient.identifier:JHN.period, Patient.name.period, Patient.telecom.period, Patient.address.period, Patient.contact.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error Patient.identifier:JHN.assigner, Patient.contact.organization, Patient.link.other SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from PatientProfile

Summary

Must-Support: 5 elements
Prohibited: 12 elements

Structures

This structure refers to these other structures:

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