QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)

Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. See the Directory of published versions

D.4.1 StructureDefinition-qicore-patient

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Basic Patient Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient

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

This profile builds on USCorePatientProfile.

This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... id 0..1id
... patient-religion 0..1CodeableConceptThe patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (example)
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... qicore-military-service 0..1CodeableConceptExplanation associated with refuted status
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service
Binding: QiCore Military Service Value Set (example)
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... identifier S1..*Identifier
.... system S1..1uri
.... value S1..1string
... active S0..1boolean
... name S1..*HumanName
.... family S1..1string
.... given S1..*string
... telecom 0..*ContactPoint
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender S1..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... generalPractitioner 0..*Reference(QICoreOrganization | QICorePractitioner)
... managingOrganization 0..1Reference(QICoreOrganization)
... link 0..*BackboneElement
.... other 1..1Reference(QICorePatient)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required)
... patient-religion 0..1CodeableConceptThe patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-religion"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... valueAddress 0..1AddressValue of extension
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-disability"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code 0..1ExtensionNationality Code
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
.... period 0..1ExtensionNationality Period
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
.... valueBoolean 0..1booleanValue of extension
... qicore-military-service 0..1CodeableConceptExplanation associated with refuted status
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
.... valueDateTime 0..1dateTimeValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ0..1booleanWhether this patient's record is in active use
... name SΣI1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
..... valueBoolean 0..1booleanValue of extension
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
..... valueBoolean 0..1booleanValue of extension
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode SΣ0..1stringUS Zip Codes
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
Max Binding: Language codes with language and optionally a region modifier
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(QICoreOrganization | QICorePractitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(QICoreOrganization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(QICorePatient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*
... id 0..1id
... patient-religion 0..1CodeableConceptThe patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (example)
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... qicore-military-service 0..1CodeableConceptExplanation associated with refuted status
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service
Binding: QiCore Military Service Value Set (example)
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... identifier S1..*Identifier
.... system S1..1uri
.... value S1..1string
... active S0..1boolean
... name S1..*HumanName
.... family S1..1string
.... given S1..*string
... telecom 0..*ContactPoint
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... gender S1..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... state 0..1stringBinding: USPS Two Letter Alphabetic Codes (preferred)
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... generalPractitioner 0..*Reference(QICoreOrganization | QICorePractitioner)
... managingOrganization 0..1Reference(QICoreOrganization)
... link 0..*BackboneElement
.... other 1..1Reference(QICorePatient)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient I0..*Information about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... us-core-race S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity S0..1(Complex)Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required)
... patient-religion 0..1CodeableConceptThe patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-religion"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... valueAddress 0..1AddressValue of extension
... patient-disability 0..*CodeableConceptCondition(s) limiting movement, senses, or activities
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-disability"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... patient-nationality 0..*(Complex)Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code 0..1ExtensionNationality Code
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"code"
..... valueCodeableConcept 0..1CodeableConceptValue of extension
.... period 0..1ExtensionNationality Period
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"period"
..... valuePeriod 0..1PeriodValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-nationality"
... patient-cadavericDonor 0..1booleanPost-mortem donor status
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
.... valueBoolean 0..1booleanValue of extension
... qicore-military-service 0..1CodeableConceptExplanation associated with refuted status
URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-military-service"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... patient-birthTime S0..1dateTimeTime of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
.... valueDateTime 0..1dateTimeValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ0..1booleanWhether this patient's record is in active use
... name SΣI1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
..... valueBoolean 0..1booleanValue of extension
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... iso21090-preferred 0..1booleanPreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
..... valueBoolean 0..1booleanValue of extension
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode SΣ0..1stringUS Zip Codes
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
Max Binding: Language codes with language and optionally a region modifier
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(QICoreOrganization | QICorePractitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(QICoreOrganization)Organization that is the custodian of the patient record
... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(QICorePatient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required)

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.extension:religion.valueCodeableConceptextensiblev3.ReligiousAffiliation
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typeextensibleIdentifier Type Codes
Patient.name.userequiredNameUse
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.statepreferredUspsTwoLetterAlphabeticCodes
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Max Binding: Language codes with language and optionally a region modifier
Patient.link.typerequiredLinkType

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4PatientIf 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-3PatientIf 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-6PatientA resource should have narrative for robust management
: text.div.exists()
dom-5PatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
us-core-8Patient.namePatient.name.given or Patient.name.family or both SHALL be present
: family.exists() or given.exists()
ele-1Patient.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
ele-1Patient.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Patient.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())