MedMe Pharmacy Services Implementation Guide
0.9.24 - ci-build Canada flag

MedMe Pharmacy Services Implementation Guide - Local Development build (v0.9.24) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MedMe Pharmacy Patient

Official URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/medme-pharmacy-patient Version: 0.9.24
Draft as of 2025-12-08 Computable Name: MedMePharmacyPatient

A profile of Patient for MedMe pharmacy services, based on Canadian Core patient profile, with essential fields for pharmacy patient management.

Usages:

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..* PatientCACore Information about an individual or animal receiving health care services
... id Σ 0..1 id Unique identifier for the patient
... meta Σ 1..1 Meta Metadata including profile version
.... source Σ 1..1 uri URI identifying the source system of the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:indigenousIdentity N 0..* CodeableConcept Extension for representing a code classifying a person's indigenous identity.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core
Binding: Indigenous Identity Code (preferred)
.... extension:racializedGroup N 0..* CodeableConcept Extension for representing a code classifying a person's racialized group.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core
Binding: Racialized Group Code (preferred)
.... extension:recordedSexOrGender 0..* (Complex) Recorded sex or gender (RSG) information includes the various sex and gender concepts.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The recorded sex or gender property for the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Value Set (extensible)
...... extension:type 0..1 Extension Type of recorded sex or gender.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Type Value Set (required)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 99502-7
......... display 1..1 string Representation defined by the system
Fixed Value: Recorded sex or gender
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:genderIdentity 0..* (Complex) Extension for representing how the person prefers to self-describe.
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The individual's gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity Value Set (extensible)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:pronouns 0..* (Complex) Third-person pronouns that may reference a person's gender identity (e.g. he, she, they)
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns profiled by http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core
.... extension:birthsex N 0..* Coding A code that specifies the sex of a person at birth which is a clinical finding
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Sex assigned at Birth (example): Code for sex assigned at birth
.... extension:CommunicationBarrier N 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Optional Extensions Element
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier
Binding: Communication Barrier (extensible)
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Slice: Unordered, Open by pattern:type
Constraints: medme-pcid-system-check, medme-pcid-count
.... identifier:JHN Σ 0..* Identifier 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 SΣ 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 1..1 string Representation defined by the system
Fixed Value: Jurisdictional Health Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:MRN Σ 0..* Identifier Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri An identifier for the system supplying the MRN
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:patientId SΣC 1..1 Identifier MedMe patient identifier
..... 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.
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: MR
....... 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
.... identifier:jhn SΣC 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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
... active ?!Σ 1..1 boolean Whether the patient is active
... name SΣC 1..* HumanName Patient's name
Constraints: ca-core-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 1..1 string Family name
.... given SΣ 1..* string Given names
This repeating element order: Patient.name.given[0] is expected to be the first name in a sequence. Patient.name.given[i], where i>0, is expected to express a Patient's middle name(s)
.... period Σ 0..1 Period Time period when name was/is in use
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period Σ 0..1 Period Time period when the contact point was/is in use
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender SΣ 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* AddressCACore Addresses for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... 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: http://terminology.hl7.org/NamingSystem/iso639-3 (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... code Σ 1..1 code Symbol in syntax defined by the system
... generalPractitioner S 0..* Reference(Practitioner (CA-Core) | PractitionerRole (CA-Core) | Organization (CA-Core)) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base extensible Recorded Gender Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base required Recorded Gender Type Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:genderIdentity.​extension:value.value[x] Base extensible Gender Identity Value Set 📦 ca.infoway.io.core v1.0
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.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:patientId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 NameUse 📍4.0.1 FHIR Std.
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.communication.​language Base preferred http://terminology.hl7.org/NamingSystem/iso639-3 Not State Unknown
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ca-core-pat-1 error Patient.name Either Patient.name.given and/or Patient.name.family SHALL be present. (family.exists() or given.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()
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())

This structure is derived from PatientCACore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientCACore Information about an individual or animal receiving health care services
... id 0..1 id Unique identifier for the patient
... meta 1..1 Meta Metadata including profile version
.... source 1..1 uri URI identifying the source system of the resource
... extension 1..* Extension Extension
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... identifier C 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Constraints: medme-pcid-system-check, medme-pcid-count
... Slices for identifier Content/Rules for all slices
.... identifier:patientId C 1..1 Identifier MedMe patient identifier
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
.... identifier:jhn C 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... extension 0..1 Extension Extension
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
... active 1..1 boolean Whether the patient is active
... name 1..* HumanName Patient's name
.... family 1..1 string Family name
.... given 1..* string Given names
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... address 0..* AddressCACore Addresses for the individual
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... relationship
..... coding 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/ValueSet/patient-contactrelationship
...... code 1..1 code Symbol in syntax defined by the system
.... name
..... family 0..1 string Family name
..... given 0..* string Given names
.... telecom 0..* ContactPoint Contact details
..... system 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value 1..1 string The actual contact point details
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... language
..... coding 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... code 1..1 code Symbol in syntax defined by the system
... managingOrganization 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
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.contact.telecom.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientCACore Information about an individual or animal receiving health care services
... id Σ 0..1 id Unique identifier for the patient
... meta Σ 1..1 Meta Metadata including profile version
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri URI identifying the source system of the resource
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indigenousIdentity N 0..* CodeableConcept Extension for representing a code classifying a person's indigenous identity.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core
Binding: Indigenous Identity Code (preferred)
.... extension:racializedGroup N 0..* CodeableConcept Extension for representing a code classifying a person's racialized group.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core
Binding: Racialized Group Code (preferred)
.... extension:recordedSexOrGender 0..* (Complex) Recorded sex or gender (RSG) information includes the various sex and gender concepts.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The recorded sex or gender property for the individual
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Value Set (extensible)
...... extension:type 0..1 Extension Type of recorded sex or gender.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Type Value Set (required)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 99502-7
......... display 1..1 string Representation defined by the system
Fixed Value: Recorded sex or gender
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:genderIdentity 0..* (Complex) Extension for representing how the person prefers to self-describe.
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The individual's gender identity
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity Value Set (extensible)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:pronouns 0..* (Complex) Third-person pronouns that may reference a person's gender identity (e.g. he, she, they)
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns profiled by http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core
.... extension:birthsex N 0..* Coding A code that specifies the sex of a person at birth which is a clinical finding
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Sex assigned at Birth (example): Code for sex assigned at birth
.... extension:CommunicationBarrier N 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Optional Extensions Element
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier
Binding: Communication Barrier (extensible)
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Slice: Unordered, Open by pattern:type
Constraints: medme-pcid-system-check, medme-pcid-count
.... identifier:JHN Σ 0..* Identifier Jurisdictional Health Number
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension: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 SΣ 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 1..1 string Representation defined by the system
Fixed Value: Jurisdictional Health Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MRN Σ 0..* Identifier Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri An identifier for the system supplying the MRN
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:patientId SΣC 1..1 Identifier MedMe patient identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:jhn SΣC 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 1..1 boolean Whether the patient is active
... name SΣC 1..* HumanName Patient's name
Constraints: ca-core-pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name
.... given SΣ 1..* string Given names
This repeating element order: Patient.name.given[0] is expected to be the first name in a sequence. Patient.name.given[i], where i>0, is expected to express a Patient's middle name(s)
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender SΣ 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... birthDate Σ 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* AddressCACore Addresses for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code 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 | both
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 SΣ 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 SΣ 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 SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
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
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/ValueSet/patient-contactrelationship
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... 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
.... name 0..1 HumanName A name associated with the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name
..... given Σ 0..* string Given names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... 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 Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: http://terminology.hl7.org/NamingSystem/iso639-3 (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... 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
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Practitioner (CA-Core) | PractitionerRole (CA-Core) | Organization (CA-Core)) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base extensible Recorded Gender Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base required Recorded Gender Type Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:genderIdentity.​extension:value.value[x] Base extensible Gender Identity Value Set 📦 ca.infoway.io.core v1.0
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.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:patientId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 NameUse 📍4.0.1 FHIR Std.
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.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred http://terminology.hl7.org/NamingSystem/iso639-3 Not State Unknown
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ca-core-pat-1 error Patient.name Either Patient.name.given and/or Patient.name.family SHALL be present. (family.exists() or given.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()
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientCACore

Summary

Mandatory: 11 elements(7 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientCACore Information about an individual or animal receiving health care services
... id Σ 0..1 id Unique identifier for the patient
... meta Σ 1..1 Meta Metadata including profile version
.... source Σ 1..1 uri URI identifying the source system of the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:indigenousIdentity N 0..* CodeableConcept Extension for representing a code classifying a person's indigenous identity.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core
Binding: Indigenous Identity Code (preferred)
.... extension:racializedGroup N 0..* CodeableConcept Extension for representing a code classifying a person's racialized group.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core
Binding: Racialized Group Code (preferred)
.... extension:recordedSexOrGender 0..* (Complex) Recorded sex or gender (RSG) information includes the various sex and gender concepts.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The recorded sex or gender property for the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Value Set (extensible)
...... extension:type 0..1 Extension Type of recorded sex or gender.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Type Value Set (required)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 99502-7
......... display 1..1 string Representation defined by the system
Fixed Value: Recorded sex or gender
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:genderIdentity 0..* (Complex) Extension for representing how the person prefers to self-describe.
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The individual's gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity Value Set (extensible)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:pronouns 0..* (Complex) Third-person pronouns that may reference a person's gender identity (e.g. he, she, they)
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns profiled by http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core
.... extension:birthsex N 0..* Coding A code that specifies the sex of a person at birth which is a clinical finding
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Sex assigned at Birth (example): Code for sex assigned at birth
.... extension:CommunicationBarrier N 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Optional Extensions Element
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier
Binding: Communication Barrier (extensible)
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Slice: Unordered, Open by pattern:type
Constraints: medme-pcid-system-check, medme-pcid-count
.... identifier:JHN Σ 0..* Identifier 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 SΣ 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 1..1 string Representation defined by the system
Fixed Value: Jurisdictional Health Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:MRN Σ 0..* Identifier Medical Record Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri An identifier for the system supplying the MRN
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:patientId SΣC 1..1 Identifier MedMe patient identifier
..... 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.
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: MR
....... 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
.... identifier:jhn SΣC 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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
... active ?!Σ 1..1 boolean Whether the patient is active
... name SΣC 1..* HumanName Patient's name
Constraints: ca-core-pat-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣ 1..1 string Family name
.... given SΣ 1..* string Given names
This repeating element order: Patient.name.given[0] is expected to be the first name in a sequence. Patient.name.given[i], where i>0, is expected to express a Patient's middle name(s)
.... period Σ 0..1 Period Time period when name was/is in use
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period Σ 0..1 Period Time period when the contact point was/is in use
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender SΣ 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* AddressCACore Addresses for the individual
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... 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: http://terminology.hl7.org/NamingSystem/iso639-3 (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... code Σ 1..1 code Symbol in syntax defined by the system
... generalPractitioner S 0..* Reference(Practitioner (CA-Core) | PractitionerRole (CA-Core) | Organization (CA-Core)) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base extensible Recorded Gender Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base required Recorded Gender Type Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:genderIdentity.​extension:value.value[x] Base extensible Gender Identity Value Set 📦 ca.infoway.io.core v1.0
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.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:patientId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 NameUse 📍4.0.1 FHIR Std.
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.communication.​language Base preferred http://terminology.hl7.org/NamingSystem/iso639-3 Not State Unknown
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ca-core-pat-1 error Patient.name Either Patient.name.given and/or Patient.name.family SHALL be present. (family.exists() or given.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()
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())

Differential View

This structure is derived from PatientCACore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientCACore Information about an individual or animal receiving health care services
... id 0..1 id Unique identifier for the patient
... meta 1..1 Meta Metadata including profile version
.... source 1..1 uri URI identifying the source system of the resource
... extension 1..* Extension Extension
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... identifier C 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Constraints: medme-pcid-system-check, medme-pcid-count
... Slices for identifier Content/Rules for all slices
.... identifier:patientId C 1..1 Identifier MedMe patient identifier
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
.... identifier:jhn C 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... extension 0..1 Extension Extension
..... type 0..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: JHN
... active 1..1 boolean Whether the patient is active
... name 1..* HumanName Patient's name
.... family 1..1 string Family name
.... given 1..* string Given names
... telecom
.... system 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... use 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... address 0..* AddressCACore Addresses for the individual
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... contact
.... relationship
..... coding 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/ValueSet/patient-contactrelationship
...... code 1..1 code Symbol in syntax defined by the system
.... name
..... family 0..1 string Family name
..... given 0..* string Given names
.... telecom 0..* ContactPoint Contact details
..... system 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... value 1..1 string The actual contact point details
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... language
..... coding 1..1 Coding Code defined by a terminology system
...... system 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... code 1..1 code Symbol in syntax defined by the system
... managingOrganization 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
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.contact.telecom.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientCACore Information about an individual or animal receiving health care services
... id Σ 0..1 id Unique identifier for the patient
... meta Σ 1..1 Meta Metadata including profile version
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 1..1 uri URI identifying the source system of the resource
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indigenousIdentity N 0..* CodeableConcept Extension for representing a code classifying a person's indigenous identity.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core
Binding: Indigenous Identity Code (preferred)
.... extension:racializedGroup N 0..* CodeableConcept Extension for representing a code classifying a person's racialized group.
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core
Binding: Racialized Group Code (preferred)
.... extension:recordedSexOrGender 0..* (Complex) Recorded sex or gender (RSG) information includes the various sex and gender concepts.
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The recorded sex or gender property for the individual
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Value Set (extensible)
...... extension:type 0..1 Extension Type of recorded sex or gender.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "type"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Recorded Gender Type Value Set (required)
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://loinc.org
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 99502-7
......... display 1..1 string Representation defined by the system
Fixed Value: Recorded sex or gender
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
...... extension:effectivePeriod 0..1 Extension When the recorded sex or gender value applies
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "effectivePeriod"
....... value[x] 0..1 Period Value of extension
...... extension:acquisitionDate 0..1 Extension When the sex or gender value was recorded.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "acquisitionDate"
....... value[x] 1..1 dateTime Value of extension
...... extension:sourceDocument 0..1 Extension The document the sex or gender property was acquired from.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceDocument"
....... value[x] 1..1 Value of extension
........ valueCodeableConcept CodeableConcept
........ valueReference Reference(DocumentReference)
...... extension:sourceField 0..1 Extension The name of the field within the source document where this sex or gender property is initially recorded.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "sourceField"
....... value[x] 1..1 string Value of extension
...... extension:jurisdiction 0..1 Extension Who issued the document where the sex or gender was aquired
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "jurisdiction"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Jurisdiction ValueSet (extensible)
...... extension:comment 0..1 Extension Context or source information about the recorded sex or gender
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
...... extension:genderElementQualifier 0..1 Extension Whether this recorded sex or gender value qualifies the .gender element.
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "genderElementQualifier"
....... value[x] 1..1 boolean Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
.... extension:genderIdentity 0..* (Complex) Extension for representing how the person prefers to self-describe.
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:value 1..1 Extension The individual's gender identity
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "value"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Gender Identity Value Set (extensible)
...... extension:period 0..1 Extension The time period during which the gender identity applies to the individual
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "period"
....... value[x] 1..1 Period Value of extension
...... extension:comment 0..1 Extension Text to further explain the use of the specified gender identity
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "comment"
....... value[x] 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
.... extension:pronouns 0..* (Complex) Third-person pronouns that may reference a person's gender identity (e.g. he, she, they)
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns profiled by http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core
.... extension:birthsex N 0..* Coding A code that specifies the sex of a person at birth which is a clinical finding
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex
Binding: Sex assigned at Birth (example): Code for sex assigned at birth
.... extension:CommunicationBarrier N 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta Optional Extensions Element
URL: http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier
Binding: Communication Barrier (extensible)
.... extension:locationId 1..1 string Reference to the location where the patient is registered
URL: https://fhir.medmehealth.com/pharmacy-services/StructureDefinition/location-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣC 1..* Identifier Patient identifiers including MedMe ID and optional JHN, PCID
Slice: Unordered, Open by pattern:type
Constraints: medme-pcid-system-check, medme-pcid-count
.... identifier:JHN Σ 0..* Identifier Jurisdictional Health Number
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension: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 SΣ 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 1..1 string Representation defined by the system
Fixed Value: Jurisdictional Health Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri A Health Number Naming System from the Canadian URI Registry
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:MRN Σ 0..* Identifier Medical Record Number
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri An identifier for the system supplying the MRN
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:patientId SΣC 1..1 Identifier MedMe patient identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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: MR
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:jhn SΣC 0..1 Identifier Optional identifier representing Patient JHN (Quebec)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..1 Extension Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... 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.
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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 1..1 boolean Whether the patient is active
... name SΣC 1..* HumanName Patient's name
Constraints: ca-core-pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name
.... given SΣ 1..* string Given names
This repeating element order: Patient.name.given[0] is expected to be the first name in a sequence. Patient.name.given[i], where i>0, is expected to express a Patient's middle name(s)
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... gender SΣ 1..1 code Administrative gender
Binding: AdministrativeGender (required)
... birthDate Σ 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* AddressCACore Addresses for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code 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 | both
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 SΣ 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 SΣ 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 SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
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
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/ValueSet/patient-contactrelationship
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... 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
.... name 0..1 HumanName A name associated with the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text Σ 0..1 string Text representation of the full name
..... family Σ 0..1 string Family name
..... given Σ 0..* string Given names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint Contact details
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
..... 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 Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement Languages which may be used to communicate with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: http://terminology.hl7.org/NamingSystem/iso639-3 (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/language
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... 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
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(Practitioner (CA-Core) | PractitionerRole (CA-Core) | Organization (CA-Core)) Patient's nominated primary care provider
... managingOrganization Σ 1..1 Reference(MedMe Pharmacy Organization) Organization that manages the care of this patient
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Patient.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:recordedSexOrGender.​extension:value.value[x] Base extensible Recorded Gender Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:type.value[x] Base required Recorded Gender Type Value Set 📦 ca.infoway.io.core v1.0
Patient.extension:recordedSexOrGender.​extension:jurisdiction.​value[x] Base extensible Jurisdiction ValueSet 📦1.0.0 THO v7.0
Patient.extension:genderIdentity.​extension:value.value[x] Base extensible Gender Identity Value Set 📦 ca.infoway.io.core v1.0
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.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:patientId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:patientId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
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 NameUse 📍4.0.1 FHIR Std.
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.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred http://terminology.hl7.org/NamingSystem/iso639-3 Not State Unknown
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ca-core-pat-1 error Patient.name Either Patient.name.given and/or Patient.name.family SHALL be present. (family.exists() or given.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()
jhn-extension-format error **ALL** elements Must provide JHN version code if extension is used extension.where(url = 'http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion').all(valueString.exists() and valueString.length() > 0)
medme-identifier-required error **ALL** elements At least one MedMe identifier is required system.matches('https://fhir\.medmehealth\.com/pharmacy-services/systems/entity/(organization/[^/]+/)?patient/id')
medme-pcid-count error Patient.identifier Maximum one PCID identifier allowed where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').count() <= 1
medme-pcid-system-check error Patient.identifier If PCID system is present, type code must be PT where(system = 'https://fhir.medmehealth.com/pharmacy-services/systems/entity/patient/pc-id').all(type.coding.where(system='http://terminology.hl7.org/CodeSystem/v2-0203' and code='PT').exists())
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientCACore

Summary

Mandatory: 11 elements(7 nested mandatory elements)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron