US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core Patient

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-patient Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCorePatient
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.39

Profile of Patient for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
address An address for the individual Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.city Name of city, town etc. Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.line Street name, number, direction & P.O. Box etc. Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.period Time period when address was/is in use Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.postalCode US Zip Codes Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.state Sub-unit of country (abbreviations ok) Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
address.use home | work | temp | old | billing - purpose of this address Patient Demographics/Information: Current Address, Patient Demographics/Information: Previous Address
birthDate The date of birth for the individual Patient Demographics/Information: Date of Birth
communication A language which may be used to communicate with the patient about his or her health Patient Demographics/Information: Preferred Language
communication.language The language which can be used to communicate with the patient about his or her health Patient Demographics/Information: Preferred Language
deceased[x] Indicates if the individual is deceased or not Patient Demographics/Information: Date of Death
extension:ethnicity US Core ethnicity Extension (multiple ethnicities are supported in the extension) Patient Demographics/Information: Ethnicity
extension:interpreterRequired Whether the patient needs an interpreter Patient Demographics/Information: Interpreter Needed
extension:race US Core Race Extension (multiple races are supported in the extension) Patient Demographics/Information: Race
extension:sex Sex Extension Patient Demographics/Information: Sex
extension:tribalAffiliation Tribal Affiliation Extension Patient Demographics/Information: Tribal Affiliation
identifier An identifier for this patient Patient Demographics/Information: Patient Identifier
identifier.system The namespace for the identifier value Patient Demographics/Information: Patient Identifier
identifier.value The value that is unique within the system. Patient Demographics/Information: Patient Identifier
name A name associated with the patient Patient Demographics/Information: First Name, Patient Demographics/Information: Last Name, Patient Demographics/Information: Middle Name (Including middle initial), Patient Demographics/Information: Name Suffix, Patient Demographics/Information: Previous Name
name.family Family name (often called 'Surname') Patient Demographics/Information: Last Name, Patient Demographics/Information: Previous Name
name.given Given names (not always 'first'). Includes middle names Patient Demographics/Information: First Name, Patient Demographics/Information: Middle Name (Including middle initial), Patient Demographics/Information: Previous Name
name.period Time period when name was/is in use Patient Demographics/Information: First Name, Patient Demographics/Information: Last Name, Patient Demographics/Information: Middle Name (Including middle initial), Patient Demographics/Information: Name Suffix, Patient Demographics/Information: Previous Name
name.suffix Parts that come after the name Patient Demographics/Information: Name Suffix, Patient Demographics/Information: Previous Name
name.use usual | official | temp | nickname | anonymous | old | maiden Patient Demographics/Information: First Name, Patient Demographics/Information: Previous Name
telecom A contact detail for the individual Patient Demographics/Information: Email Address, Patient Demographics/Information: Phone Number
telecom.system phone | fax | email | pager | url | sms | other Patient Demographics/Information: Email Address, Patient Demographics/Information: Phone Number
telecom.use home | work | temp | old | mobile - purpose of this contact point Patient Demographics/Information: Email Address, Patient Demographics/Information: Phone Number, Patient Demographics/Information: Phone Number Type
telecom.value The actual contact point details Patient Demographics/Information: Email Address, Patient Demographics/Information: Phone Number

Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core Patient Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race C 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 Coding (USCDI+ Quality) Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns . (required): Answer Set with Yes No and Unknowns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI+ Quality) A name associated with the patient
Constraints: us-core-6
.... use ?!Σ 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣC 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI+ Quality) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI+ Quality) Time period when name was/is in use
... telecom Σ 0..* ContactPoint (USCDI+ Quality) A contact detail for the individual
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... birthDate SΣ 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] ?!Σ 0..1 (USCDI+ Quality) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address (USCDI+ Quality) An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string (USCDI+ Quality) 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
Example US Core: 49 MEADOW ST
.... city SΣ 0..1 string (USCDI+ Quality) Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... state SΣ 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
.... postalCode SΣ 0..1 string (USCDI+ Quality) US Zip Codes
Example General: 9132
Example US Core: 74047
.... period Σ 0..1 Period (USCDI+ Quality) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 0..* BackboneElement (USCDI+ Quality) A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.2
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.2
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
us-core-23 error Patient.extension:race If "ASKU" or "UNK" are present, then no other OMB race categories can be present. extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:race 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 USCoreInterpreterNeededExtension (USCDI+ Quality) Whether the patient needs an interpreter
... identifier 1..* Identifier (USCDI+ Quality) An identifier for this patient
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) The value that is unique within the system.
... name 1..* HumanName (USCDI+ Quality) A name associated with the patient
.... use 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
.... family 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
.... suffix 0..* string (USCDI+ Quality) Parts that come after the name
.... period 0..1 Period (USCDI+ Quality) Time period when name was/is in use
.... system 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
.... value 1..1 string (USCDI+ Quality) The actual contact point details
.... use 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
... birthDate 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] 0..1 boolean, dateTime (USCDI+ Quality) Indicates if the individual is deceased or not
... address 0..* Address (USCDI+ Quality) An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
.... line 0..* string (USCDI+ Quality) Street name, number, direction & P.O. Box etc.
.... city 0..1 string (USCDI+ Quality) Name of city, town etc.
.... state 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string (USCDI+ Quality) US Zip Codes
.... period 0..1 Period (USCDI+ Quality) Time period when address was/is in use
... communication 0..* BackboneElement (USCDI+ Quality) A language which may be used to communicate with the patient about his or her health
.... language 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
... link 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:race C 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 Coding (USCDI+ Quality) Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns . (required): Answer Set with Yes No and Unknowns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier (USCDI+ Quality) An identifier for this patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique within the system.
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI+ Quality) A name associated with the patient
Constraints: us-core-6
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣC 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI+ Quality) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI+ Quality) Time period when name was/is in use
... telecom Σ 0..* ContactPoint (USCDI+ Quality) A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] ?!Σ 0..1 (USCDI+ Quality) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address (USCDI+ Quality) An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI+ Quality) 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
Example US Core: 49 MEADOW ST
.... city SΣ 0..1 string (USCDI+ Quality) Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
.... postalCode SΣ 0..1 string (USCDI+ Quality) US Zip Codes
Example General: 9132
Example US Core: 74047
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI+ Quality) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement (USCDI+ Quality) 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
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 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
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.2
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.2
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
us-core-23 error Patient.extension:race If "ASKU" or "UNK" are present, then no other OMB race categories can be present. extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race C 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 Coding (USCDI+ Quality) Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns . (required): Answer Set with Yes No and Unknowns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI+ Quality) A name associated with the patient
Constraints: us-core-6
.... use ?!Σ 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣC 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI+ Quality) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI+ Quality) Time period when name was/is in use
... telecom Σ 0..* ContactPoint (USCDI+ Quality) A contact detail for the individual
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... birthDate SΣ 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] ?!Σ 0..1 (USCDI+ Quality) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address (USCDI+ Quality) An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string (USCDI+ Quality) 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
Example US Core: 49 MEADOW ST
.... city SΣ 0..1 string (USCDI+ Quality) Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... state SΣ 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
.... postalCode SΣ 0..1 string (USCDI+ Quality) US Zip Codes
Example General: 9132
Example US Core: 74047
.... period Σ 0..1 Period (USCDI+ Quality) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... communication 0..* BackboneElement (USCDI+ Quality) A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.2
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.2
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
us-core-23 error Patient.extension:race If "ASKU" or "UNK" are present, then no other OMB race categories can be present. extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:race 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 USCoreInterpreterNeededExtension (USCDI+ Quality) Whether the patient needs an interpreter
... identifier 1..* Identifier (USCDI+ Quality) An identifier for this patient
.... system 1..1 uri (USCDI+ Quality) The namespace for the identifier value
.... value 1..1 string (USCDI+ Quality) The value that is unique within the system.
... name 1..* HumanName (USCDI+ Quality) A name associated with the patient
.... use 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
.... family 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
.... suffix 0..* string (USCDI+ Quality) Parts that come after the name
.... period 0..1 Period (USCDI+ Quality) Time period when name was/is in use
.... system 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
.... value 1..1 string (USCDI+ Quality) The actual contact point details
.... use 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
... birthDate 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] 0..1 boolean, dateTime (USCDI+ Quality) Indicates if the individual is deceased or not
... address 0..* Address (USCDI+ Quality) An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
.... line 0..* string (USCDI+ Quality) Street name, number, direction & P.O. Box etc.
.... city 0..1 string (USCDI+ Quality) Name of city, town etc.
.... state 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string (USCDI+ Quality) US Zip Codes
.... period 0..1 Period (USCDI+ Quality) Time period when address was/is in use
... communication 0..* BackboneElement (USCDI+ Quality) A language which may be used to communicate with the patient about his or her health
.... language 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
... link 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... other 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* USCorePatientProfile(9.0.0) Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:race C 0..1 (Complex) (USCDI+ Quality) US Core Race Extension (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
.... extension:ethnicity 0..1 (Complex) (USCDI+ Quality) US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
.... extension:tribalAffiliation 0..* (Complex) (USCDI+ Quality) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
.... extension:sex 0..1 Coding (USCDI+ Quality) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-individual-sex
Binding: Federal Administrative Sex . (extensible): Federal Administrative Sex
.... extension:interpreterRequired 0..1 Coding (USCDI+ Quality) Whether the patient needs an interpreter
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-interpreter-needed
Binding: Answer Set with Yes No and Unknowns . (required): Answer Set with Yes No and Unknowns
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier (USCDI+ Quality) An identifier for this patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri (USCDI+ Quality) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string (USCDI+ Quality) The value that is unique within the system.
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI+ Quality) A name associated with the patient
Constraints: us-core-6
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code (USCDI+ Quality) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family SΣC 0..1 string (USCDI+ Quality) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI+ Quality) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI+ Quality) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI+ Quality) Time period when name was/is in use
... telecom Σ 0..* ContactPoint (USCDI+ Quality) A contact detail for the individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code (USCDI+ Quality) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI+ Quality) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI+ Quality) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate SΣ 0..1 date (USCDI+ Quality) The date of birth for the individual
... deceased[x] ?!Σ 0..1 (USCDI+ Quality) Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address (USCDI+ Quality) An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:address-preferred 0..1 boolean Preferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?!Σ 0..1 code (USCDI+ Quality) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI+ Quality) 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
Example US Core: 49 MEADOW ST
.... city SΣ 0..1 string (USCDI+ Quality) Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI+ Quality) Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
Example US Core: OK
.... postalCode SΣ 0..1 string (USCDI+ Quality) US Zip Codes
Example General: 9132
Example US Core: 74047
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI+ Quality) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement (USCDI+ Quality) 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
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept (USCDI+ Quality) The language which can be used to communicate with the patient about his or her health
Binding: Languages (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 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
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(US Quality Core Patient | US Quality Core Patient) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.2
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Languages 📦1.0.0 THO v7.2
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
us-core-23 error Patient.extension:race If "ASKU" or "UNK" are present, then no other OMB race categories can be present. extension.where(url = 'ombCategory').value.where(code in 'ASKU'|'UNK').exists() implies extension.where(url = 'ombCategory').count() = 1

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Core US Quality Core
extension:race Additional USCDI USCDI+ Quality
extension:ethnicity Additional USCDI USCDI+ Quality
extension:tribalAffiliation Additional USCDI USCDI+ Quality
extension:sex Additional USCDI USCDI+ Quality
extension:interpreterRequired Additional USCDI USCDI+ Quality
identifier Mandatory Must Support USCDI+ Quality
identifier.system Mandatory Must Support USCDI+ Quality
identifier.value Mandatory Must Support USCDI+ Quality
name Mandatory Must Support USCDI+ Quality
name.use Additional USCDI USCDI+ Quality
name.family Must Support USCDI+ Quality
name.given Must Support USCDI+ Quality
name.suffix Additional USCDI USCDI+ Quality
name.period Additional USCDI USCDI+ Quality
telecom Additional USCDI USCDI+ Quality
telecom.system Mandatory Must Support USCDI+ Quality
telecom.value Mandatory Must Support USCDI+ Quality
telecom.use Must Support USCDI+ Quality
birthDate Must Support USCDI+ Quality
deceased[x] Additional USCDI USCDI+ Quality
address Must Support USCDI+ Quality
address.use Additional USCDI USCDI+ Quality
address.line Must Support USCDI+ Quality
address.city Must Support USCDI+ Quality
address.state Must Support USCDI+ Quality
address.postalCode Must Support USCDI+ Quality
address.period Additional USCDI USCDI+ Quality
communication Additional USCDI USCDI+ Quality
communication.language Mandatory Must Support USCDI+ Quality
link.other Mandatory
link.type Mandatory

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.

Mandatory US Quality Core Server Search Parameters

The searches below are the focused set identified by US Quality Core as needed to retrieve USCDI+ Quality data for quality measurement and reporting. See the US Core FHIR RESTful Search API Requirements for detailed information on requirements by search parameter type.

Because this profile derives directly or indirectly from US Core, servers SHALL also support all mandatory searches described in the US Core Server CapabilityStatement requirements for Patient. When possible, this guide reuses mandatory searches from US Core and notes them with the EXISTING US CORE REQUIREMENT flag. While US Quality Core may restate US Core requirements to highlight searches directly relevant to USCDI+ Quality data access, US Core requirements not restated here remain applicable.

See the US Quality Core Server CapabilityStatement for complete requirements for the underlying Patient resource and Search Requirement Selection for how this focused set was selected.

Servers supporting this profile SHALL support the following search parameters and search parameter combinations:

  1. SHALL support searching for a Patient resource by id using the _id search parameter. EXISTING US CORE REQUIREMENT

    • Including optional support for OR search on _id (e.g._id=[id],[id],...).

    GET [base]/Patient?_id=[id]

    Example:

    GET [base]/Patient?_id=example

    Implementation Notes: Fetches a bundle of US Quality Core Patient resources matching the specified search criteria. See how to search by token.

    Rationale for inclusion: Supports retrieval of a known Patient resource by id.