Left: | IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient) |
Right: | Patient Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient' vs 'http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient' |
Information | StructureDefinition.name | Values for name differ: 'IPAPatient' vs 'PatientProfile' |
Information | StructureDefinition.title | Values for title differ: 'IPA-Patient' vs 'Patient Profile' |
Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' |
Information | StructureDefinition.date | Values for date differ: '2022-08-02' vs '2024-11-14' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Canada - FHIR Implementation Work Group' |
Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001' |
Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#CA' |
Information | StructureDefinition.short | Values for short differ: 'Information about an individual or animal receiving health care services' vs 'Patient Profile' |
Information | StructureDefinition.definition | Values for definition differ: 'Demographics and other administrative information about an individual or animal receiving care or other health-related services.' vs 'The Patient Profile is based upon the core FHIR Patient Resource' |
Information | StructureDefinition.short | Values for short differ: 'Additional content defined by implementations' vs 'Extension' |
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'An Extension' |
Information | StructureDefinition.short | Values for short differ: 'An identifier for this patient' vs 'An identifier intended for computation' |
Information | StructureDefinition.definition | Values for definition differ: 'An identifier for this patient.' vs 'An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.' |
Warning | Patient.identifier | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | Patient.identifier | Element minimum cardinalities differ: '1' vs '0' |
Information | StructureDefinition.comment | Values for comment differ: 'This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.' vs 'The slice provided below is one example of an identifier type and has been socialized because of a Canadian extension on that identifier type. It is not required, and the slicing is open meaning that other types can be provided.' |
Information | Patient.identifier.system | Element minimum cardinalities differ: '0' vs '1' |
Warning | Patient.identifier.value | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.active | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.gender | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.link | Elements differ in definition for mustSupport: 'true' vs 'false' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Patient | ||
copyright | Used by permission of HL7 International all rights reserved Creative Commons License |
| |
date | 2022-08-02 | 2024-11-14 |
|
description | Minimum expectations for a Patient resource when accessed via a International Patient Access API. This profile describes how applications fetch the Patient resource to check the patient identity and access basic demographics and other administrative information about the patient. | Proposed constraints and extensions on the Patient Resource |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
jurisdiction[1] | urn:iso:std:iso:3166#CA |
| |
kind | resource | ||
name | IPAPatient | PatientProfile |
|
publisher | HL7 International / Patient Care | HL7 Canada - FHIR Implementation Work Group |
|
purpose | |||
status | active | draft |
|
title | IPA-Patient | Patient Profile |
|
type | Patient | ||
url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient | http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient |
|
version | 1.1.0 |
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | Patient | Information about an individual or animal receiving health care services ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present | 0..* | Patient | Patient Profile | ||||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | SOΣC | 1..* | Identifier | An identifier for this patient ipa-pat-1: At least one of Patient.identifier.system or Patient.identifier.type or Patient.identifier.assigner SHALL be present
| 0..* | ?? | An identifier intended for computation Slice: Unordered, Open by pattern:type |
| |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 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 | 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: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| ||||||||
value | SOΣ | 1..1 | string | The value that is unique within the system. Example General: 123456
| Σ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
| ||||||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 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) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
active | ?!SOΣC | 0..1 | boolean | Whether this patient's record is in active use
| ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| ||||||||
name | SOΣC | 0..* | HumanName | A name associated with the patient ipa-pat-2: Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present. ipa-pat-3: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present.
| SΣC | 0..* | HumanName | A name associated with the patient ca-baseline-name: Patient.name.given or Patient.name.family or both SHALL be present | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 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: ?? (required): The use of a human name. |
| ||||||||||||
text | Σ | 0..1 | string | Text representation of the full name |
| ||||||||||||
family | Σ | 0..1 | string | Family name (often called 'Surname') |
| ||||||||||||
given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| ||||||||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| ||||||||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| ||||||||||||
period | Σ | 0..1 | Period | Time period when name was/is in use |
| ||||||||||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | Σ | 0..* | ContactPoint | A contact detail for the individual | |||||||||
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 |
| |||||||||||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. |
| ||||||||||||
value | Σ | 1..1 | string | The actual contact point details |
| ||||||||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (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 |
| ||||||||||||
gender | SOΣ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes.
| Σ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. |
| ||||||||
birthDate | SOΣ | 0..1 | date | The date of birth for the individual
| SΣ | 0..1 | date | The date of birth for the individual | |||||||||
deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |||||||||
address | Σ | 0..* | Address | An address for the individual | Σ | 0..* | Address | An address for the individual | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| |||||||||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home |
| ||||||||||||
type | Σ | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both |
| ||||||||||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| ||||||||||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| ||||||||||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| ||||||||||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| ||||||||||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| ||||||||||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 |
| ||||||||||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| ||||||||||||
period | Σ | 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: ?? (extensible): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | |||||||||||
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |||||||||||
photo | 0..* | Attachment | Image of the patient | 0..* | Attachment | Image of the patient | |||||||||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||
name | 0..1 | HumanName | A name associated with the contact person | 0..1 | HumanName | A name associated with the contact person | |||||||||||
telecom | 0..* | ContactPoint | A contact detail for the person | 0..* | ContactPoint | A contact detail for the person | |||||||||||
address | 0..1 | Address | Address for the contact person | 0..1 | Address | Address for the contact person | |||||||||||
gender | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||||
organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | 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 | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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: ?? (preferred): A human language.
| 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language.
| |||||||||||
preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||||||
link | ?!SOΣC | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
| ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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 | Σ | 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: ?? (required): The type of link between this patient resource and another patient resource. | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | |||||||||
Documentation for this format |