CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG
1.0.0 - Release 1

CDC National Healthcare Safety Network (NHSN) Digital Quality Measures (dQM) Content Package IG - Downloaded Version 1.0.0 See the Directory of published versions

## Resource Profile: Cross-Measure Patient Profile

Official URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/cross-measure-patient | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 1 | Computable Name: CrossMeasurePatient

This profile contains NHSN-specific Required and Must-Support elements for reporting Patient information on public-health surveillance measures to NHSN.

This profile is based on US Core Patient 3.1.1.

NHSN only recognizes the data element 'sex', with male and female as the only accepted responses. These data are mapped from either the patient.extension (birthsex), or patient.gender FHIR standard data elements. These two FHIR standard data elements provide male/female options, per US Core 3.1.1.

For data submitted for patient.gender, and/or patient.extension (birthsex) that do not align with male or female, NHSN will label those responses as not reported. As national standards update, this resource will also be updated.

Usages:

- Use this Profile: NHSN MeasureReport Bundle and NHSN Subject Bundle
- Examples for this Profile: Patient/patient-example-ach-daily-influenzatherapeutic, Patient/patient-example-ach-daily-initialpopulationpass, Patient/patient-example-ach-daily-negativepcr, Patient/patient-example-ach-daily-rsvlabbtg... Show 3 more, Patient/patient-example-ach-monthly-pass1, Patient/patient-example-ach-monthly-pass2 and Patient/patient-example-ach-monthly-pass3

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:race | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
use | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 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 | 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
period | S Σ | 0..1 | Period | Time period when id is/was valid for use
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the patient Constraints: us-core-8
use | ?!S Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | 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
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | S Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | S Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!S Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | An address for the individual
use | ?!S Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | 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"}
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 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 | S | 0..1 | HumanName | A name associated with the contact person
address | S | 0..1 | Address | Address for the contact person
period | S | 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
modifierExtension | ?!Σ | 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: Language codes with language and optionally a region modifier (extensible)
preferred | S | 0..1 | boolean | Language preference indicator
link | ?!S Σ | 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(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier `http://hl7.org/fhir/us/core/ValueSet/simple-language`
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id |  | 1..1 | id | Logical id of this artifact
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:link-received-date-extension |  | 0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:race |  | 0..1 | USCoreRaceExtension | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.)
extension:ethnicity |  | 0..1 | USCoreEthnicityExtension | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.)
identifier |  |  |  |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known)
type | S | 0..1 | CodeableConcept | Description of identifier
period | S | 0..1 | Period | Time period when id is/was valid for use
name |  |  |  |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
text | S | 0..1 | string | Text representation of the full name
prefix | S | 0..* | string | Parts that come before the name
suffix | S | 0..* | string | Parts that come after the name
period | S | 0..1 | Period | Time period when name was/is in use
telecom |  |  |  |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S | 0..1 | Period | Time period when the contact point was/is in use
birthDate |  | 1..1 | date | The date of birth for the individual
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not
address |  |  |  |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address
type | S | 0..1 | code | postal | physical | both
text | S | 0..1 | string | Text representation of the address
district | S | 0..1 | string | District name (aka county)
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
relationship | S | 0..* | CodeableConcept | The kind of relationship
name | S | 0..1 | HumanName | A name associated with the contact person
address | S | 0..1 | Address | Address for the contact person
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  |  |  |
preferred | S | 0..1 | boolean | Language preference indicator
link | S | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
other |  |  |  |
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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:link-received-date-extension |  | 0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | 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 | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 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 | 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
period | S Σ | 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 | A name associated with the patient Constraints: us-core-8
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 | ?!S Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | 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
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | S Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | 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 | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | S Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!S Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | An address 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
use | ?!S Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | 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"}
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 | S 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 | S | 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 | S | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address | S | 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 | S | 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
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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred | S | 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 | ?!S Σ | 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(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` From the FHIR Standard
Patient.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` From the FHIR Standard
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier `http://hl7.org/fhir/us/core/ValueSet/simple-language`
Patient.link.other.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types|4.0.1` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

This structure is derived from USCorePatientProfile

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 23 elements

Extensions

This structure refers to these extensions:

- http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:race | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | An identifier for this patient
use | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 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 | 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
period | S Σ | 0..1 | Period | Time period when id is/was valid for use
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use
name | S Σ C | 1..* | HumanName | A name associated with the patient Constraints: us-core-8
use | ?!S Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | 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
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | S Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | S Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!S Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | An address for the individual
use | ?!S Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | 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"}
contact | S C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | S | 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 | S | 0..1 | HumanName | A name associated with the contact person
address | S | 0..1 | Address | Address for the contact person
period | S | 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
modifierExtension | ?!Σ | 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: Language codes with language and optionally a region modifier (extensible)
preferred | S | 0..1 | boolean | Language preference indicator
link | ?!S Σ | 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(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier `http://hl7.org/fhir/us/core/ValueSet/simple-language`
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

Differential View

This structure is derived from USCorePatientProfile

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id |  | 1..1 | id | Logical id of this artifact
meta |  |  |  |
Slices for extension |  |  |  | Content/Rules for all slices
extension:link-received-date-extension |  | 0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:race |  | 0..1 | USCoreRaceExtension | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.)
extension:ethnicity |  | 0..1 | USCoreEthnicityExtension | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.)
identifier |  |  |  |
use | S | 0..1 | code | usual | official | temp | secondary | old (If known)
type | S | 0..1 | CodeableConcept | Description of identifier
period | S | 0..1 | Period | Time period when id is/was valid for use
name |  |  |  |
use | S | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden
text | S | 0..1 | string | Text representation of the full name
prefix | S | 0..* | string | Parts that come before the name
suffix | S | 0..* | string | Parts that come after the name
period | S | 0..1 | Period | Time period when name was/is in use
telecom |  |  |  |
rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S | 0..1 | Period | Time period when the contact point was/is in use
birthDate |  | 1..1 | date | The date of birth for the individual
deceased[x] | S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not
address |  |  |  |
use | S | 0..1 | code | home | work | temp | old | billing - purpose of this address
type | S | 0..1 | code | postal | physical | both
text | S | 0..1 | string | Text representation of the address
district | S | 0..1 | string | District name (aka county)
country | S | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
relationship | S | 0..* | CodeableConcept | The kind of relationship
name | S | 0..1 | HumanName | A name associated with the contact person
address | S | 0..1 | Address | Address for the contact person
period | S | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient
communication |  |  |  |
preferred | S | 0..1 | boolean | Language preference indicator
link | S | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
other |  |  |  |
reference |  | 1..1 | string | Literal reference, Relative, internal or absolute URL
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Patient |  | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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:link-received-date-extension |  | 0..1 | dateTime | Received Date URL: http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity | S | 0..1 | (Complex) | US Core Race Extension (If present, must include at least one of the required codes. Preferably this would include at least a code in the ombCategory slice.) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..* | Identifier | 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 | ?!S Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | S Σ | 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 | 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
period | S Σ | 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 | A name associated with the patient Constraints: us-core-8
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 | ?!S Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | S Σ | 0..1 | string | Text representation of the full name
family | S Σ C | 0..1 | string | 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
prefix | S Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | S Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | S Σ | 0..1 | Period | Time period when name was/is in use
telecom | S Σ | 0..* | ContactPoint | 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 | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!S Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank | S Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | S Σ | 0..1 | Period | Time period when the contact point was/is in use
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required)
birthDate | S Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!S Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
address | S Σ | 0..* | Address | An address 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
use | ?!S Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | S Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | S Σ | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon
district | S Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132
country | 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"}
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 | S 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 | S | 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 | S | 0..1 | HumanName | A name associated with the contact person
telecom |  | 0..* | ContactPoint | A contact detail for the person
address | S | 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 | S | 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
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 | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred | S | 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 | ?!S Σ | 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(Patient | RelatedPerson) | The other patient or related person resource that the link refers to
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Patient.meta.security | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels|4.0.1` From the FHIR Standard
Patient.meta.tag | example | CommonTags `http://hl7.org/fhir/ValueSet/common-tags|4.0.1` From the FHIR Standard
Patient.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Patient.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Patient.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Patient.name.use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` From the FHIR Standard
Patient.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system` From the FHIR Standard
Patient.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use` From the FHIR Standard
Patient.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender` From the FHIR Standard
Patient.address.use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` From the FHIR Standard
Patient.address.type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` From the FHIR Standard
Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
Patient.maritalStatus | extensible | Marital Status Codes `http://hl7.org/fhir/ValueSet/marital-status` From the FHIR Standard
Patient.contact.relationship | extensible | PatientContactRelationship `http://hl7.org/fhir/ValueSet/patient-contactrelationship` From the FHIR Standard
Patient.contact.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` From the FHIR Standard
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier `http://hl7.org/fhir/us/core/ValueSet/simple-language`
Patient.link.other.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types|4.0.1` From the FHIR Standard
Patient.link.type | required | LinkType `http://hl7.org/fhir/ValueSet/link-type|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |

This structure is derived from USCorePatientProfile

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 23 elements

Extensions

This structure refers to these extensions:

- http://www.cdc.gov/nhsn/fhirportal/dqm/ig/StructureDefinition/link-received-date-extension

Maturity: 1

Other representations of profile: CSV, Excel, Schematron