Left: | C4BB Patient (http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient) |
Right: | C4BB Patient (http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient) |
Error | StructureDefinition.version | Values for version differ: '2.0.0' vs '2.1.0-snapshot1' |
Information | StructureDefinition.date | Values for date differ: '2022-11-28T15:16:46+00:00' vs '2024-07-27T20:09:37+08:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 Financial Management Working Group' vs 'HL7 International / Financial Management' |
Information | StructureDefinition.definition | Values for definition differ: 'The US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.' vs '\-' |
Information | StructureDefinition.definition | Values for definition differ: 'A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.' vs 'A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.' |
Information | StructureDefinition.definition | Values for definition differ: 'A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).' vs 'A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).' |
Information | StructureDefinition.short | Values for short differ: 'An identifier for this patient' vs '(USCDI) An identifier for this patient' |
Information | StructureDefinition.short | Values for short differ: 'The namespace for the identifier value' vs '(USCDI) The namespace for the identifier value' |
Information | StructureDefinition.short | Values for short differ: 'The value that is unique within the system.' vs '(USCDI) The value that is unique within the system.' |
Information | StructureDefinition.short | Values for short differ: 'A name associated with the patient' vs '(USCDI) A name associated with the patient' |
Information | StructureDefinition.short | Values for short differ: 'usual | official | temp | nickname | anonymous | old | maiden' vs '(USCDI) usual | official | temp | nickname | anonymous | old | maiden' |
Information | StructureDefinition.short | Values for short differ: 'Family name (often called 'Surname')' vs '(USCDI) Family name (often called 'Surname')' |
Information | StructureDefinition.short | Values for short differ: 'Given names (not always 'first'). Includes middle names' vs '(USCDI) Given names (not always 'first'). Includes middle names' |
Information | StructureDefinition.short | Values for short differ: 'Parts that come after the name' vs '(USCDI) Parts that come after the name' |
Information | StructureDefinition.short | Values for short differ: 'Time period when name was/is in use' vs '(USCDI) Time period when name was/is in use' |
Information | StructureDefinition.short | Values for short differ: 'A contact detail for the individual' vs '(USCDI) A contact detail for the individual' |
Warning | Patient.telecom | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'phone | fax | email | pager | url | sms | other' vs '(USCDI) phone | fax | email | pager | url | sms | other' |
Information | StructureDefinition.short | Values for short differ: 'The actual contact point details' vs '(USCDI) The actual contact point details' |
Information | StructureDefinition.short | Values for short differ: 'home | work | temp | old | mobile - purpose of this contact point' vs '(USCDI) home | work | temp | old | mobile - purpose of this contact point' |
Information | StructureDefinition.short | Values for short differ: 'male | female | other | unknown' vs '(USCDI) male | female | other | unknown' |
Information | StructureDefinition.short | Values for short differ: 'The date of birth for the individual' vs '(USCDI) The date of birth for the individual' |
Information | StructureDefinition.short | Values for short differ: 'Indicates if the individual is deceased or not' vs '(USCDI) Indicates if the individual is deceased or not' |
Information | StructureDefinition.short | Values for short differ: 'An address for the individual' vs '(USCDI) An address for the individual' |
Information | StructureDefinition.short | Values for short differ: 'home | work | temp | old | billing - purpose of this address' vs '(USCDI) home | work | temp | old | billing - purpose of this address' |
Information | StructureDefinition.short | Values for short differ: 'Street name, number, direction & P.O. Box etc.' vs '(USCDI) Street name, number, direction & P.O. Box etc.' |
Information | StructureDefinition.short | Values for short differ: 'Name of city, town etc.' vs '(USCDI) Name of city, town etc.' |
Information | StructureDefinition.short | Values for short differ: 'Sub-unit of country (abbreviations ok)' vs '(USCDI) Sub-unit of country (abbreviations ok)' |
Information | StructureDefinition.short | Values for short differ: 'US Zip Codes' vs '(USCDI) US Zip Codes' |
Information | StructureDefinition.short | Values for short differ: 'Time period when address was/is in use' vs '(USCDI) Time period when address was/is in use' |
Warning | Patient.address.period | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: 'A language 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 for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.short | Values for short differ: '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' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||
copyright | |||
date | 2022-11-28T15:16:46+00:00 | 2024-07-27T20:09:37+08:00 |
|
description | This profile builds upon the US Core Patient profile. It is used to convey information about the patient who received the services described on the claim. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | C4BBPatient | ||
publisher | HL7 Financial Management Working Group | HL7 International / Financial Management |
|
purpose | |||
status | active | ||
title | C4BB Patient | ||
type | Patient | ||
url | http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient | ||
version | 2.0.0 | 2.1.0-snapshot1 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services patient-meta-profile-version: Patient: meta.profile with canonical and major.minor. version required. | 0..* | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services This profile also complies with the profile US Core Patient Profile (3.1.1) | ||||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | SΣ | 1..1 | Meta | Metadata about the resource | SΣ | 1..1 | Meta | Metadata about the resource | |||||||||
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 | |||||||||||
versionId | Σ | 0..1 | id | Version specific identifier | Σ | 0..1 | id | Version specific identifier | |||||||||
lastUpdated | SΣ | 1..1 | instant | When the resource version last changed | SΣ | 1..1 | instant | When the resource version last changed | |||||||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | Σ | 0..1 | uri | Identifies where the resource comes from | |||||||||
profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||||
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 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 | |||||||||||
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 | |||||||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | SΣ | 1..* | Identifier | (USCDI) An identifier for this patient 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) | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible) | |||||||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | 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ΣC | 1..* | HumanName | A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. | 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 | 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 | (USCDI) 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 | Σ | 0..1 | string | Text representation of the full name | |||||||||
family | SΣC | 0..1 | string | Family name (often called 'Surname') | SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | |||||||||
given | SΣC | 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 | 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 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 | (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 | SΣ | 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 | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | |||||||||
value | SΣ | 1..1 | string | The actual contact point details | SΣ | 1..1 | string | (USCDI) The actual contact point details | |||||||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required) | ?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ?? (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: ?? (required) | SΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: ?? (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 | |||||||||
Slices for deceased[x] | ?!SΣ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | ?!SΣ | 0..1 | boolean, dateTime | (USCDI) Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||||||
address | SΣ | 0..* | Address | An address 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: ?? (required): The use of an address. Example General: home | ?!Σ | 0..1 | code | (USCDI) 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 | Σ | 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 | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 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 | SΣ | 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 | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. | SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. | |||||||||
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | |||||||||
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||
period | SΣ | 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: ?? (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 | S | 0..* | BackboneElement | A language 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 | 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 | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) | S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) | |||||||||
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 | ?!Σ | 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 |