Left: | Argonaut Patient Profile (http://fhir.org/guides/argonaut/StructureDefinition/argo-patient) |
Right: | US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient) |
Error | StructureDefinition.url | Values for url differ: 'http://fhir.org/guides/argonaut/StructureDefinition/argo-patient' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient' |
Information | StructureDefinition.name | Values for name differ: 'Argonaut Patient Profile' vs 'USCorePatientProfile' |
Information | StructureDefinition.status | Values for status differ: 'draft' vs 'active' |
Information | StructureDefinition.date | Values for date differ: '2016-10-18T00:00:00+11:00' vs '2022-09-30' |
Information | StructureDefinition.publisher | Values for publisher differ: 'Argonaut Project' vs 'HL7 International - Cross-Group Projects' |
Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US' |
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '1.0.2' vs '4.0.1' |
Warning | Patient | Elements differ in short: 'Argonaut Patient Profile' vs 'Information about an individual or animal receiving health care services' |
Warning | Patient | Elements differ in definition: 'Demographics and other administrative information about an individual or animal receiving care or other health-related services.' vs '\-' |
Information | Patient | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible (contained.contained.empty()) |
Information | Patient | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible (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()) |
Information | Patient | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
Information | Patient | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible (contained.meta.security.empty()) |
Information | Patient | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible (text.`div`.exists()) |
Warning | Patient.id | Elements differ in comments: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.' vs 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.' |
Warning | Patient.meta | Elements differ in definition: 'The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.' vs 'The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.' |
Warning | Patient.implicitRules | Elements differ in definition: 'A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.' vs 'A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.' |
Warning | Patient.implicitRules | Elements differ in comments: 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.' vs 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.' |
Warning | Patient.language | Elements differ in comments: 'Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).' vs 'Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).' |
Warning | Patient.text | Elements differ in definition: 'A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' vs 'A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' |
Warning | Patient.text | Elements differ in comments: 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.' vs 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a 'text blob' or where text is additionally entered raw or narrated and encoded information is added later.' |
Warning | Patient.contained | Elements differ in comments: 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.' vs 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.' |
Warning | Patient.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Patient.identifier | Elements differ in short: 'An identifier for this patient' vs '(USCDI) An identifier for this patient' |
Warning | Patient.identifier.id | Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
Warning | Patient.identifier.id | Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
Warning | Patient.identifier.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. 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.' |
Warning | Patient.identifier.use | Elements differ in short: 'usual | official | temp | secondary (If known)' vs 'usual | official | temp | secondary | old (If known)' |
Warning | Patient.identifier.use | Elements differ in comments: 'This is labeled as 'Is Modifier' because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.' vs 'Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.' |
Warning | Patient.identifier.system | Elements differ in short: 'The namespace for the identifier' vs '(USCDI) The namespace for the identifier value' |
Warning | Patient.identifier.system | Elements differ in definition: 'Establishes the namespace in which set of possible id values is unique.' vs 'Establishes the namespace for the value - that is, a URL that describes a set values that are unique.' |
Warning | Patient.identifier.system | Elements differ in requirements: 'There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.' vs 'There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.' |
Warning | Patient.identifier.value | Elements differ in short: 'The value that is unique within the system.' vs '(USCDI) The value that is unique within the system.' |
Warning | Patient.identifier.value | Elements differ in definition: 'The portion of the identifier typically displayed to the user and which is unique within the context of the system.' vs 'The portion of the identifier typically relevant to the user and which is unique within the context of the system.' |
Warning | Patient.identifier.value | Elements differ in comments: 'If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.' vs 'If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension]. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.' |
Warning | Patient.identifier.assigner | Elements differ in comments: 'The reference may be just a text description of the assigner.' vs 'The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.' |
Warning | Patient.active | Elements differ in definition: 'Whether this patient record is in active use.' vs 'Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.' |
Warning | Patient.active | Elements differ in comments: 'Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.' vs 'If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.' |
Warning | Patient.name | Elements differ in short: 'A name associated with the patient' vs '(USCDI) A name associated with the patient' |
Information | Patient.name | StructureDefinition USCorePatientProfile has added constraint that is not found in Argonaut Patient Profile and it is uncertain whether they are compatible ((family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()) |
Warning | Patient.name.id | Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
Warning | Patient.name.id | Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
Warning | Patient.name.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. 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.' |
Warning | Patient.name.use | Elements differ in short: 'usual | official | temp | nickname | anonymous | old | maiden' vs '(USCDI) usual | official | temp | nickname | anonymous | old | maiden' |
Warning | Patient.name.use | Elements differ in comments: 'This is labeled as 'Is Modifier' because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.' vs 'Applications can assume that a name is current unless it explicitly says that it is temporary or old.' |
Warning | Patient.name.use | Elements differ in description: 'The use of a human name' vs 'The use of a human name.' |
Warning | Patient.name.use | Elements differ in description: 'The use of a human name' vs 'The use of a human name.' |
Warning | Patient.name.text | Elements differ in definition: 'A full text representation of the name.' 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 comments: 'Can provide both a text representation and structured parts.' vs 'Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.' |
Warning | Patient.name.family | Elements differ in short: 'Family name (often called 'Surname')' vs '(USCDI) Family name (often called 'Surname')' |
Warning | Patient.name.family | Elements differ in comments: 'For family name, hyphenated names such as 'Smith-Jones' are a single name, but names with spaces such as 'Smith Jones' are broken into multiple parts.' vs 'Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).' |
Information | Patient.name.family | Element minimum cardinalities differ: '1' vs '0' |
Information | Patient.name.family | Element maximum cardinalities differ: '2147483647' vs '1' |
Warning | Patient.name.given | Elements differ in short: 'Given names (not always 'first'). Includes middle names' vs '(USCDI) Given names (not always 'first'). Includes middle names' |
Warning | Patient.name.given | Elements differ in comments: 'If only initials are recorded, they may be used in place of the full name. Not called 'first name' since given names do not always come first.' vs 'If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called 'first name' since given names do not always come first.' |
Information | Patient.name.given | Element minimum cardinalities differ: '1' vs '0' |
Warning | Patient.name.suffix | Elements differ in short: 'Parts that come after the name' vs '(USCDI) Parts that come after the name' |
Warning | Patient.name.period | Elements differ in short: 'Time period when name was/is in use' vs '(USCDI) Time period when name was/is in use' |
Warning | Patient.telecom | Elements differ in short: 'A contact detail for the individual' vs '(USCDI) A contact detail for the individual' |
Warning | Patient.telecom | Elements differ in comments: 'A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).' vs 'A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).' |
Warning | Patient.telecom.system | Elements differ in short: 'phone | fax | email | pager | url | sms | other' vs '(USCDI) phone | fax | email | pager | url | sms | other' |
Warning | Patient.telecom.system | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | Patient.telecom.system | Element minimum cardinalities differ: '0' vs '1' |
Warning | Patient.telecom.value | Elements differ in short: 'The actual contact point details' vs '(USCDI) The actual contact point details' |
Warning | Patient.telecom.value | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | Patient.telecom.value | Element minimum cardinalities differ: '0' vs '1' |
Warning | Patient.telecom.use | Elements differ in short: 'home | work | temp | old | mobile - purpose of this contact point' vs '(USCDI) home | work | temp | old | mobile - purpose of this contact point' |
Warning | Patient.telecom.use | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.gender | Elements differ in short: 'male | female | other | unknown' vs '(USCDI) male | female | other | unknown' |
Warning | Patient.gender | Elements differ in comments: 'The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a 'hard' error.' vs 'The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a 'hard' error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.' |
Warning | Patient.gender | Elements differ in requirements: 'Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.' vs 'Needed for identification of the individual, in combination with (at least) name and birth date.' |
Warning | Patient.birthDate | Elements differ in short: 'The date of birth for the individual' vs '(USCDI) The date of birth for the individual' |
Warning | Patient.birthDate | Elements differ in comments: 'At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension 'patient-birthTime' available that should be used where Time is required (such as in maternaty/infant care systems).' vs 'At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension 'patient-birthTime' available that should be used where Time is required (such as in maternity/infant care systems).' |
Warning | Patient.deceased[x] | Elements differ in short: 'Indicates if the individual is deceased or not' vs '(USCDI) Indicates if the individual is deceased or not' |
Warning | Patient.deceased[x] | Elements differ in comments: 'If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.' vs 'If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.' |
Warning | Patient.address | Elements differ in short: 'Addresses for the individual' vs '(USCDI) An address for the individual' |
Warning | Patient.address | Elements differ in definition: 'Addresses for the individual.' vs 'An address for the individual.' |
Warning | Patient.address | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.address.use | Elements differ in short: 'home | work | temp | old | billing - purpose of this address' vs '(USCDI) home | work | temp | old | billing - purpose of this address' |
Warning | Patient.address.line | Elements differ in short: 'Street name, number, direction & P.O. Box etc.' vs '(USCDI) Street name, number, direction & P.O. Box etc.' |
Warning | Patient.address.line | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.address.city | Elements differ in short: 'Name of city, town etc.' vs '(USCDI) Name of city, town etc.' |
Warning | Patient.address.city | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.address.state | Elements differ in short: 'Sub-unit of country (abbreviations ok)' vs '(USCDI) Sub-unit of country (abbreviations ok)' |
Warning | Patient.address.state | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.address.postalCode | Elements differ in short: 'Postal code for area' vs '(USCDI) US Zip Codes' |
Warning | Patient.address.postalCode | Elements differ in definition for mustSupport: 'false' vs 'true' |
Warning | Patient.address.period | Elements differ in short: 'Time period when address was/is in use' vs '(USCDI) Time period when address was/is in use' |
Warning | Patient.multipleBirth[x] | Elements differ in definition: 'Indicates whether the patient is part of a multiple or indicates the actual birth order.' vs 'Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).' |
Warning | Patient.contact.id | Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
Warning | Patient.contact.id | Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
Warning | Patient.contact.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. 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.' |
Warning | Patient.contact.modifierExtension | Elements differ in short: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized' |
Warning | Patient.contact.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Error | Patient.contact.relationship | Unable to resolve left value set http://hl7.org/fhir/ValueSet/patient-contact-relationship at Patient.contact.relationship |
Warning | Patient.communication | Elements differ in short: 'A list of Languages which may be used to communicate with the patient about his or her health' vs '(USCDI) A language which may be used to communicate with the patient about his or her health' |
Warning | Patient.communication | Elements differ in definition: 'Languages which may be used to communicate with the patient about his or her health.' vs 'A language which may be used to communicate with the patient about his or her health.' |
Warning | Patient.communication | Elements differ in comments: 'If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.' vs 'If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.' |
Warning | Patient.communication | Elements differ in requirements: 'If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.' vs 'If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.' |
Warning | Patient.communication | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | Patient.communication.id | Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
Warning | Patient.communication.id | Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
Warning | Patient.communication.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. 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.' |
Warning | Patient.communication.modifierExtension | Elements differ in short: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized' |
Warning | Patient.communication.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Patient.communication.language | Elements differ in short: 'The language which can be used to communicate with the patient about his or her health' vs '(USCDI) The language which can be used to communicate with the patient about his or her health' |
Warning | Patient.link | Elements differ in requirements: 'There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.' vs 'There are multiple use cases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.' |
Warning | Patient.link.id | Elements differ in short: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
Warning | Patient.link.id | Elements differ in definition: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
Warning | Patient.link.extension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'May be used to represent additional information that is not part of the basic definition of the element. 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.' |
Warning | Patient.link.modifierExtension | Elements differ in short: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized' |
Warning | Patient.link.modifierExtension | Elements differ in definition: 'May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' |
Warning | Patient.link.other | Elements differ in short: 'The other patient resource that the link refers to' vs 'The other patient or related person resource that the link refers to' |
Warning | Patient.link.type | Elements differ in short: 'replace | refer | seealso - type of link' vs 'replaced-by | replaces | refer | seealso' |
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 | 2016-10-18T00:00:00+11:00 | 2022-09-30 |
|
description | The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v3 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases. |
| |
experimental | false |
| |
fhirVersion | 1.0.2 | 4.0.1 |
|
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US |
| |
kind | resource | ||
name | Argonaut Patient Profile | USCorePatientProfile |
|
publisher | Argonaut Project | HL7 International - Cross-Group Projects |
|
purpose | |||
status | draft | active |
|
title | US Core Patient Profile |
| |
type | Patient | ||
url | http://fhir.org/guides/argonaut/StructureDefinition/argo-patient | http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient |
|
version | 6.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 | Argonaut Patient Profile | 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: todo (required): A human language. | 0..1 | code | Language of the resource content Binding: todo (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 |
| ||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 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 | S | 1..* | Identifier | An identifier for this patient | SΣ | 1..* | Identifier | (USCDI) An identifier for this patient |
| ||||
id | 0..1 | id | xml:id (or equivalent in JSON) | 0..1 | string | Unique id for inter-element referencing |
| ||||||
extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| ||||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: todo (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: todo (required): Identifies the purpose for this identifier, if known . |
| ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: todo (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: todo (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
system | S | 1..1 | uri | The namespace for the identifier Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri | SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| ||||
value | S | 1..1 | string | The value that is unique within the system. Example General: 123456 | SΣ | 1..1 | string | (USCDI) 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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| ||||
name | S | 1..* | HumanName | A name associated with the patient | SΣC | 1..* | HumanName | (USCDI) A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. |
| ||||
id | 0..1 | id | xml:id (or equivalent in JSON) | 0..1 | string | Unique id for inter-element referencing |
| ||||||
extension | 0..* | Extension | Additional Content defined by implementations | 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: todo (required): The use of a human name | ?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: todo (required): The use of a human name. |
| ||||
text | Σ | 0..1 | string | Text representation of the full name | Σ | 0..1 | string | Text representation of the full name |
| ||||
family | S | 1..* | string | Family name (often called 'Surname') | SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') |
| ||||
given | S | 1..* | string | Given names (not always 'first'). Includes middle names | SΣC | 0..* | string | (USCDI) 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 | Σ | 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 | Σ | 0..* | string | (USCDI) 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 | (USCDI) Time period when name was/is in use |
| ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | Σ | 0..* | ContactPoint | (USCDI) A contact detail for the individual |
| ||||
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 | |||||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: todo (required): Telecommunications form for contact point. | SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: todo (required): Telecommunications form for contact point. |
| ||||
value | Σ | 0..1 | string | The actual contact point details | SΣ | 1..1 | string | (USCDI) The actual contact point details |
| ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: todo (required): Use of contact point. | ?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: todo (required) |
| ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||
gender | S | 1..1 | code | male | female | other | unknown Binding: todo (required) | SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: todo (required) |
| ||||
birthDate | S | 0..1 | date | The date of birth for the individual | SΣ | 0..1 | date | (USCDI) 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 | (USCDI) Indicates if the individual is deceased or not |
| ||||
address | Σ | 0..* | Address | Addresses for the individual | SΣ | 0..* | Address | (USCDI) An address for the individual |
| ||||
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 | home | work | temp | old | billing - purpose of this address Binding: todo (required): The use of an address. Example General: home | ?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: todo (required): The use of an address. Example General: home |
| ||||
type | Σ | 0..1 | code | postal | physical | both Binding: todo (required): The type of an address (physical / postal). Example General: both | Σ | 0..1 | code | postal | physical | both Binding: todo (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 | Σ | 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 | SΣ | 0..* | string | (USCDI) 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 | SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon |
| ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: todo (extensible): Two Letter USPS alphabetic codes. |
| ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 |
| ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | Σ | 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"} | Σ | 0..1 | Period | (USCDI) 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: todo (required): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: todo (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 | |||||
id | 0..1 | id | xml:id (or equivalent in JSON) | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: todo (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: todo (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: todo (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: todo (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 | |||||||
animal | ?! | 0..0 |
| ||||||||||
communication | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health | 0..* | BackboneElement | (USCDI) A language which may be used to communicate with the patient about his or her health |
| |||||
id | 0..1 | id | xml:id (or equivalent in JSON) | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: todo (required) | S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: todo (extensible) |
| ||||
preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||
careProvider | 0..* | Reference(Organization | Practitioner) | 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 | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| ||||
id | 0..1 | id | xml:id (or equivalent in JSON) | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| ||||
other | ?! | 1..1 | Reference(Patient) | The other patient 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 | replace | refer | seealso - type of link Binding: todo (required): The type of link between this patient resource and another patient resource. | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: todo (required): The type of link between this patient resource and another patient resource. |
| ||||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
| |||||||||
Documentation for this format |