Left: | Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips) |
Right: | IPA-Patient (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips' vs 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient' |
Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '1.0.0' |
Information | StructureDefinition.name | Values for name differ: 'PatientUvIps' vs 'IPAPatient' |
Information | StructureDefinition.title | Values for title differ: 'Patient (IPS)' vs 'IPA-Patient' |
Information | StructureDefinition.date | Values for date differ: '2022-11-22T03:24:39+00:00' vs '2022-08-02' |
Information | StructureDefinition.publisher | Values for publisher differ: 'Health Level Seven International - Patient Care Work Group' vs 'HL7 International - Patient Care Work Group' |
Information | Patient.identifier | Element minimum cardinalities differ: '0' vs '1' |
Warning | Patient.identifier.value | Elements differ in short: 'The value that is unique' vs 'The value that is unique within the system.' |
Warning | Patient.identifier.value | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | Patient.identifier.value | Element minimum cardinalities differ: '0' vs '1' |
Warning | Patient.active | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.name | Elements differ in requirements: 'Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided' vs 'Need to be able to track the patient by multiple names. Examples are your official name and a partner name.' |
Information | Patient.name | Element minimum cardinalities differ: '1' vs '0' |
Warning | Patient.name.text | Elements differ in definition: 'Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element' vs 'Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.' |
Warning | Patient.name.text | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.name.family | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.name.given | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.telecom | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | Patient.birthDate | Element minimum cardinalities differ: '1' vs '0' |
Warning | Patient.address | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.contact.relationship | Elements differ in short: 'Concept - reference to a terminology or just text' vs 'The kind of relationship' |
Warning | Patient.contact.relationship | Elements differ in definition: 'A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.' vs 'The nature of the relationship between the patient and the contact person.' |
Warning | Patient.generalPractitioner | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.link | Elements differ in definition for mustSupport: 'false' vs 'true' |
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-11-22T03:24:39+00:00 | 2022-08-02 |
|
description | This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources. | 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. |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | PatientUvIps | IPAPatient |
|
publisher | Health Level Seven International - Patient Care Work Group | HL7 International - Patient Care Work Group |
|
purpose | |||
status | active | ||
title | Patient (IPS) | IPA-Patient |
|
type | Patient | ||
url | http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient |
|
version | 1.1.0 | 1.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | 0..* | Patient | Information about an individual or animal receiving health care services | |||||||||||
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 | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | SΣ | 0..* | Identifier | An identifier for this patient | SΣ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 |
| ||||||||
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 | Σ | 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 | SΣ | 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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ?!SΣC | 0..1 | boolean | Whether this patient's record is in active use ipa-pat-4: If Patient.link is present, then Patient.active SHALL be present |
| ||||||||
name | SΣC | 1..* | HumanName | A name associated with the patient ips-pat-1: Patient.name.given, Patient.name.family or Patient.name.text SHALL be present | SΣ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. |
| ||||||||
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 | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. | |||||||||
text | SΣ | 0..1 | string | Text representation of the full name | Σ | 0..1 | string | Text representation of the full name |
| ||||||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | Σ | 0..1 | string | Family name (often called 'Surname') |
| ||||||||
given | SΣ | 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 | Σ | 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 | Σ | 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 | Σ | 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 | Σ | 0..1 | Period | Time period when name was/is in use | |||||||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the individual | Σ | 0..* | ContactPoint | A contact detail for the individual |
| ||||||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | SΣ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||
birthDate | SΣ | 1..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 | SΣC | 0..* | Address | An address for the individual pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. | Σ | 0..* | Address | An address for the individual |
| ||||||||
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 | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |||||||||
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..* | ?? | Concept - reference to a terminology or just text 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 | S | 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 | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ?!SΣC | 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 |