BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
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
| Official URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-patient | Version: 1.0.0 | |||
| Active as of 2024-06-07 | Computable Name: ClientRegistryPatient | |||
General constraints on the Patient resource for use in the BC Client Registry project.
Note
This specification is currently published as a Draft Standard on the ministry GitHub and is not intended for implementation. Feedback is welcome but readers should understand that there is more work to be done in testing the profiles and operations defined in this guide. For more information, please see the Future Plans page in this guide.
Patient is a core resource of the Client Registry FHIR implementation. Patients are returned by queries (Find Candidates and Get Demographics) and modified or updated by AddPatient, RevisePatient and MergePatient FHIR Operations. This profile primarily adds extensions to elements that the core Patient resource does not include such as business dates.
In the context of the Get Demographics request message, the Patient resource must not have both a resource id ( Patient.id) and a identifier(Patient.identifier) in the same request. If they are both supplied the message will be rejected.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PatientProfile
| Path | Conformance | ValueSet | URI |
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | |
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | |
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient |
0..* | PatientProfile | Patient Profile | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
Content/Rules for all slices | |||
   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 |
| 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 |
| 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 |
| 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. |
| effectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
 genderIdentity |
S | 0..1 | (Complex) | BC Gender Identity with business dates. URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-identity-extension |
 modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for identifier |
SΣ | 0..* | IdentifierCABaseline | An identifier intended for computation Slice: Unordered, Open by pattern:type |
  identifier:All Slices |
Content/Rules for all slices | |||
 Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| idStatus |
S | 0..1 | code | BC Identifier Status URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-identifier-status-extension Binding: BC Identifier Status Value Set (required) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
 identifier:JHN |
0..* | IdentifierCABaseline | An identifier intended for computation | |
  Slices for extension |
Content/Rules for all slices | |||
 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. Fixed Value: As shown (Jurisdictional health number) |
 id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: JHN | |
| display |
0..0 | string | Representation defined by the system | |
 userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | 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 |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name |
SΣC | 0..* | HumanName | A name associated with the patient ca-baseline-name: Patient.name.given or Patient.name.family or both SHALL be present |
| Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| use |
?!Σ | 0..1 | code | usual | official | nickname Binding: BC Name Use value set. (required) |
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. |
| Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| system |
ΣC | 1..1 | code | phone | email Binding: BC Contact Point System Value Set (required) |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | mobile Binding: BC Contact Point Use Value Set (required) |
| gender |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| genderEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Gender History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-history-extension |
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| birthDateEffectiveDates |
0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Birth Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-birthdate-history-extension |
| deceased[x] |
?!SΣ | 0..1 | dateTime | Indicates if the individual is deceased or not |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deathDateEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| deathDateHistory |
S | 0..* | (Complex) | BC Death Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-date-history-extension |
| verifiedDeathFlag |
S | 0..1 | (Complex) | BC Death Verified Flag URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-verified-flag-extension |
| address |
SΣ | 0..* | Address | An address for the individual |
| Slices for extension |
Content/Rules for all slices | |||
| preferred |
N | 0..1 | boolean | HL7 Preferred Address Flag extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred |
| noFixedAddress |
N | 0..1 | boolean | No Fixed Address indicator URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| validationStatus |
S | 0..1 | code | BC Address Validation Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-validation-status-extension Binding: BC Address Validation Value Set (required) |
| 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 |
 multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||
| multipleBirth[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
| multipleBirthEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Multiple Birth History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-multiplebirth-history-extension |
| multipleBirthBoolean |
boolean | |||
| multipleBirthInteger |
integer | |||
| link |
?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| Slices for extension |
Content/Rules for all slices | |||
| mergeStatus |
S | 0..* | code | BC Merge Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-merge-status-extension Binding: BC Merge Status Value Set (required) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:JHN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:JHN.type | extensible | Fixed Value: JHNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | |
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | |
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ca-baseline-name | error | Patient.name | Patient.name.given or Patient.name.family or both SHALL be present : family.exists() or given.exists() | |
| 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() | |
| ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | PatientProfile | Patient Profile | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | ||||
| 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 | ||||
| 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 | ||||
| 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. | ||||
| effectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| genderIdentity |
S | 0..1 | (Complex) | BC Gender Identity with business dates. URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-identity-extension | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for identifier |
SΣ | 0..* | IdentifierCABaseline | An identifier intended for computation Slice: Unordered, Open by pattern:type | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| idStatus |
S | 0..1 | code | BC Identifier Status URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-identifier-status-extension Binding: BC Identifier Status Value Set (required) | ||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
| period |
ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
| assigner |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| identifier:JHN |
0..* | IdentifierCABaseline | An identifier intended for computation | |||||
| 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 | ||||
| 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. Fixed Value: As shown (Jurisdictional health number) | ||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..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..0 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: JHN | |||||
| display |
0..0 | string | Representation defined by the system | |||||
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..0 | 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 per-1: If present, start SHALL have a lower value than end | ||||
| assigner |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
SΣC | 0..* | HumanName | A name associated with the patient ca-baseline-name: Patient.name.given or Patient.name.family or both SHALL be present | ||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| 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 per-1: If present, start SHALL have a lower value than end | ||||
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| system |
ΣC | 1..1 | code | phone | email Binding: BC Contact Point System Value Set (required) | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | mobile Binding: BC Contact Point Use Value Set (required) | ||||
| 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 per-1: If present, start SHALL have a lower value than end | ||||
| gender |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Gender History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-history-extension | ||||
| value |
0..1 | string | Primitive value for code | |||||
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthDateEffectiveDates |
0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | |||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Birth Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-birthdate-history-extension | ||||
| value |
0..1 | date | Primitive value for date | |||||
| deceased[x] |
?!SΣ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deathDateEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| deathDateHistory |
S | 0..* | (Complex) | BC Death Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-date-history-extension | ||||
| verifiedDeathFlag |
S | 0..1 | (Complex) | BC Death Verified Flag URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-verified-flag-extension | ||||
| value |
0..1 | dateTime | Primitive value for dateTime | |||||
| address |
SΣ | 0..* | 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 | ||||
| preferred |
N | 0..1 | boolean | HL7 Preferred Address Flag extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | ||||
| noFixedAddress |
N | 0..1 | boolean | No Fixed Address indicator URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| validationStatus |
S | 0..1 | code | BC Address Validation Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-validation-status-extension Binding: BC Address Validation Value Set (required) | ||||
| 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 per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| 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 | ||||||
| multipleBirth[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| multipleBirthEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Multiple Birth History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-multiplebirth-history-extension | ||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 |
C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
| 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
| period |
C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
| managingOrganization |
ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
| link |
?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| 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 | ||||
| mergeStatus |
S | 0..* | code | BC Merge Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-merge-status-extension Binding: BC Merge Status Value Set (required) | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.identifier:JHN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier:JHN.type | extensible | Fixed Value: JHNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | ||||
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | ||||
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| ca-baseline-name | error | Patient.name | Patient.name.given or Patient.name.family or both SHALL be present : family.exists() or given.exists() | |
| 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() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| per-1 | error | Patient.identifier.period, 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.assigner, Patient.identifier:JHN.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from PatientProfile
Differential View
This structure is derived from PatientProfile
| Path | Conformance | ValueSet | URI |
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | |
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | |
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient |
0..* | PatientProfile | Patient Profile | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
Content/Rules for all slices | |||
| 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 |
| 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 |
| 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 |
| 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. |
| effectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| genderIdentity |
S | 0..1 | (Complex) | BC Gender Identity with business dates. URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-identity-extension |
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for identifier |
SΣ | 0..* | IdentifierCABaseline | An identifier intended for computation Slice: Unordered, Open by pattern:type |
| identifier:All Slices |
Content/Rules for all slices | |||
| Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| idStatus |
S | 0..1 | code | BC Identifier Status URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-identifier-status-extension Binding: BC Identifier Status Value Set (required) |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
| identifier:JHN |
0..* | IdentifierCABaseline | An identifier intended for computation | |
| Slices for extension |
Content/Rules for all slices | |||
| 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. Fixed Value: As shown (Jurisdictional health number) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..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..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: JHN | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | 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 |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name |
SΣC | 0..* | HumanName | A name associated with the patient ca-baseline-name: Patient.name.given or Patient.name.family or both SHALL be present |
| Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| use |
?!Σ | 0..1 | code | usual | official | nickname Binding: BC Name Use value set. (required) |
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. |
| Slices for extension |
Content/Rules for all slices | |||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| system |
ΣC | 1..1 | code | phone | email Binding: BC Contact Point System Value Set (required) |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | mobile Binding: BC Contact Point Use Value Set (required) |
| gender |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| genderEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Gender History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-history-extension |
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| birthDateEffectiveDates |
0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Birth Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-birthdate-history-extension |
| deceased[x] |
?!SΣ | 0..1 | dateTime | Indicates if the individual is deceased or not |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deathDateEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| deathDateHistory |
S | 0..* | (Complex) | BC Death Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-date-history-extension |
| verifiedDeathFlag |
S | 0..1 | (Complex) | BC Death Verified Flag URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-verified-flag-extension |
| address |
SΣ | 0..* | Address | An address for the individual |
| Slices for extension |
Content/Rules for all slices | |||
| preferred |
N | 0..1 | boolean | HL7 Preferred Address Flag extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred |
| noFixedAddress |
N | 0..1 | boolean | No Fixed Address indicator URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| validationStatus |
S | 0..1 | code | BC Address Validation Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-validation-status-extension Binding: BC Address Validation Value Set (required) |
| 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 |
| multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||
| multipleBirth[x]All Types |
Content/Rules for all Types | |||
| Slices for extension |
Content/Rules for all slices | |||
| multipleBirthEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension |
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension |
| history |
S | 0..* | (Complex) | BC Multiple Birth History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-multiplebirth-history-extension |
| multipleBirthBoolean |
boolean | |||
| multipleBirthInteger |
integer | |||
| link |
?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| Slices for extension |
Content/Rules for all slices | |||
| mergeStatus |
S | 0..* | code | BC Merge Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-merge-status-extension Binding: BC Merge Status Value Set (required) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:JHN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Patient.identifier:JHN.type | extensible | Fixed Value: JHNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | |
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | |
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG | |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| ca-baseline-name | error | Patient.name | Patient.name.given or Patient.name.family or both SHALL be present : family.exists() or given.exists() | |
| 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() | |
| ref-1 | error | Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | PatientProfile | Patient Profile | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| 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 | ||||
| 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 | ||||
| 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 | ||||
| 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. | ||||
| effectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| genderIdentity |
S | 0..1 | (Complex) | BC Gender Identity with business dates. URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-identity-extension | ||||
| modifierExtension |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for identifier |
SΣ | 0..* | IdentifierCABaseline | An identifier intended for computation Slice: Unordered, Open by pattern:type | ||||
| identifier:All Slices |
Content/Rules for all slices | |||||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| idStatus |
S | 0..1 | code | BC Identifier Status URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-identifier-status-extension Binding: BC Identifier Status Value Set (required) | ||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
| period |
ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
| assigner |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| identifier:JHN |
0..* | IdentifierCABaseline | An identifier intended for computation | |||||
| 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 | ||||
| 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. Fixed Value: As shown (Jurisdictional health number) | ||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension | Additional content defined by implementations | |||||
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..0 | string | Unique id for inter-element referencing | |||||
| extension |
0..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..0 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: JHN | |||||
| display |
0..0 | string | Representation defined by the system | |||||
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..0 | 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 per-1: If present, start SHALL have a lower value than end | ||||
| assigner |
ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
SΣC | 0..* | HumanName | A name associated with the patient ca-baseline-name: Patient.name.given or Patient.name.family or both SHALL be present | ||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| 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 per-1: If present, start SHALL have a lower value than end | ||||
| telecom |
SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
| 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 | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| system |
ΣC | 1..1 | code | phone | email Binding: BC Contact Point System Value Set (required) | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | mobile Binding: BC Contact Point Use Value Set (required) | ||||
| 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 per-1: If present, start SHALL have a lower value than end | ||||
| gender |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| genderEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Gender History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-gender-history-extension | ||||
| value |
0..1 | string | Primitive value for code | |||||
| birthDate |
SΣ | 0..1 | date | The date of birth for the individual | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| birthDateEffectiveDates |
0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | |||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Birth Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-birthdate-history-extension | ||||
| value |
0..1 | date | Primitive value for date | |||||
| deceased[x] |
?!SΣ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deathDateEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| deathDateHistory |
S | 0..* | (Complex) | BC Death Date History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-date-history-extension | ||||
| verifiedDeathFlag |
S | 0..1 | (Complex) | BC Death Verified Flag URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-death-verified-flag-extension | ||||
| value |
0..1 | dateTime | Primitive value for dateTime | |||||
| address |
SΣ | 0..* | 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 | ||||
| preferred |
N | 0..1 | boolean | HL7 Preferred Address Flag extension URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred | ||||
| noFixedAddress |
N | 0..1 | boolean | No Fixed Address indicator URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-nofixedaddress | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| validationStatus |
S | 0..1 | code | BC Address Validation Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-validation-status-extension Binding: BC Address Validation Value Set (required) | ||||
| 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 per-1: If present, start SHALL have a lower value than end Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| 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 | ||||||
| multipleBirth[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| multipleBirthEffectiveDates |
S | 0..1 | Period | BC Business Dates URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-business-period-extension | ||||
| sourceID |
S | 0..1 | (Complex) | BC SourceID and UserID URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-sourceId-extension | ||||
| history |
S | 0..* | (Complex) | BC Multiple Birth History URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-multiplebirth-history-extension | ||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 |
C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
| 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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
| period |
C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
| 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 |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
| managingOrganization |
ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
| link |
?!SΣ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| 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 | ||||
| mergeStatus |
S | 0..* | code | BC Merge Status Code URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-merge-status-extension Binding: BC Merge Status Value Set (required) | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.identifier:JHN.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Patient.identifier:JHN.type | extensible | Fixed Value: JHNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.name.use | required | NameUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-name-use-value-setfrom this IG | ||||
| Patient.telecom.system | required | ContactPointSystemVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-system-value-setfrom this IG | ||||
| Patient.telecom.use | required | ContactPointUseVShttps://terminology.hlth.gov.bc.ca/ClientRegistry/ValueSet/bc-contact-point-use-value-setfrom this IG | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| att-1 | error | Patient.photo | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
| ca-baseline-name | error | Patient.name | Patient.name.given or Patient.name.family or both SHALL be present : family.exists() or given.exists() | |
| 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() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| per-1 | error | Patient.identifier.period, 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.assigner, Patient.identifier:JHN.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from PatientProfile
Other representations of profile: CSV, Excel, Schematron