Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.1 - STU 2.2 United States of America flag

Da Vinci Prior Authorization Support (PAS) FHIR IG, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pas/ and changes regularly. See the Directory of published versions

Resource Profile: PAS Beneficiary Patient

Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-beneficiary Version: 2.2.1
Standards status: Trial-use Maturity Level: 4 Computable Name: PASBeneficiary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.24.42.45

A patient who is the beneficiary of an insurance plan.

NOTE: X12 allows for an identifier for beneficiaries that is the "HIPAA Individual Identifier". This is defined as a standard unique health identifier for each individual of the United States. At this time, the Identifier system of such an identifier is not known. Assuming that it would be defined, this identifier would be conveyed as a Patient.identifier.

X12 standard requires no dash for ZIP+4 codes and that intermediaries SHALL expect the dash to be present and SHALL remove the dash, if present, when converting the zip code to meet the X12 standard.§prof-ben-1

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (extensible): Concepts used for general documentation of sex representation
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element must be supported. This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element must be supported. This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. C 0..1 date The date of birth for the individual
Constraints: FullDateRule
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 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
Example General: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
Patient.address.district This element must be supported. This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two Letter USPS alphabetic codes.
Example General: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
Patient.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for multipleBirth[x].multipleBirthBoolean boolean
Patient.Slices for multipleBirth[x].multipleBirthInteger integer
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (7.0.0) (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍7.0.0 US Core v7.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.name
Patient.name.prefix This element must be supported. 0..* string Parts that come before the name
Patient.name.suffix This element must be supported. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.birthDate C 0..1 date The date of birth for the individual
Patient.address
Patient.address.district This element must be supported. 0..1 string District name (aka county)
Patient.address.country This element must be supported. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (extensible): Concepts used for general documentation of sex representation
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type This element is included in summaries. 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.
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element must be supported. This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element must be supported. This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. C 0..1 date The date of birth for the individual
Constraints: FullDateRule
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 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
Example General: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
Patient.address.district This element must be supported. This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two Letter USPS alphabetic codes.
Example General: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
Patient.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for multipleBirth[x].multipleBirthBoolean boolean
Patient.Slices for multipleBirth[x].multipleBirthInteger integer
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (7.0.0) (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍7.0.0 US Core v7.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10

This structure is derived from USCorePatientProfile

Summary

Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.multipleBirth[x]

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (extensible): Concepts used for general documentation of sex representation
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element must be supported. This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element must be supported. This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. C 0..1 date The date of birth for the individual
Constraints: FullDateRule
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 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
Example General: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
Patient.address.district This element must be supported. This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two Letter USPS alphabetic codes.
Example General: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
Patient.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for multipleBirth[x].multipleBirthBoolean boolean
Patient.Slices for multipleBirth[x].multipleBirthInteger integer
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (7.0.0) (extensible)
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍7.0.0 US Core v7.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.name
Patient.name.prefix This element must be supported. 0..* string Parts that come before the name
Patient.name.suffix This element must be supported. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
Patient.birthDate C 0..1 date The date of birth for the individual
Patient.address
Patient.address.district This element must be supported. 0..1 string District name (aka county)
Patient.address.country This element must be supported. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.Slices for multipleBirth[x] 0..1 boolean, integer Whether patient is part of a multiple birth
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (3.1.1) and US Core Patient Profile (6.1.0)
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.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
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race C 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core Race Extension. (multiple races are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: us-core-23
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: US Core ethnicity Extension (multiple ethnicities are supported in the extension)
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:tribalAffiliation 0..* (Complex) 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Patient.Slices for extension.extension:birthsex 0..1 code Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:sex 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex (extensible): Concepts used for general documentation of sex representation
Patient.Slices for extension.extension:genderIdentity 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Patient.identifier.id 0..1 string Unique id for inter-element referencing
Patient.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.identifier.type This element is included in summaries. 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.
Patient.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique within the system.
Example General: 123456
Patient.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.name This element must be supported. This element is included in summaries. C 1..* HumanName A name associated with the patient
Constraints: us-core-6
Patient.name.id 0..1 string Unique id for inter-element referencing
Patient.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.name.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Patient.name.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.name.family This element must be supported. This element is included in summaries. C 0..1 string Family name (often called 'Surname')
Patient.name.given This element must be supported. This element is included in summaries. 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
Patient.name.prefix This element must be supported. This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.name.suffix This element must be supported. This element is included in summaries. 0..* string 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.name.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. C 0..1 date The date of birth for the individual
Constraints: FullDateRule
Patient.deceased[x] This element is a modifier element. This element is included in summaries. 0..1 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
Patient.deceased[x].deceasedBoolean boolean
Patient.deceased[x].deceasedDateTime dateTime
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 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
Example General: 49 MEADOW ST
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
Patient.address.district This element must be supported. This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (7.0.0) (extensible): Two Letter USPS alphabetic codes.
Example General: OK
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
Patient.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Patient.address.period This element is included in summaries. 0..1 Period 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.Slices for multipleBirth[x] 0..1 Whether patient is part of a multiple birth
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for multipleBirth[x].multipleBirthBoolean boolean
Patient.Slices for multipleBirth[x].multipleBirthInteger integer
Patient.Slices for multipleBirth[x].multipleBirth[x]:multipleBirthInteger This element must be supported. 0..1 integer Whether patient is part of a multiple birth
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (7.0.0) (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.link.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍7.0.0 US Core v7.0
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍7.0.0 US Core v7.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
FullDateRule error Patient.birthDate Dates need to be a full date - YYYY-MM-DD $this.toString().length() = 10

This structure is derived from USCorePatientProfile

Summary

Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.multipleBirth[x]

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron