PAS Subscriber Patient - Da Vinci Prior Authorization Support (PAS) FHIR IG v2.1.0-preview

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

race

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
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.

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

tribalAffiliation

0..*

(Complex)

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation

birthsex

0..1

Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex

(required): Code for sex assigned at birth

sex

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex

(extensible): Concepts used for general documentation of sex representation

genderIdentity

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity

(extensible)

militaryStatus

0..1

Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-militaryStatus
Binding: https://valueset.x12.org/x217/005010/request/2010C/INS/1/08/00/584 (required): Codes showing the general employment status of an employee/claimant. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.

?!

0..*

Extensions that cannot be ignored

identifier

SΣ

1..*

Identifier

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Σ

0..1

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.

SΣ

1..1

The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

SΣ

1..1

The value that is unique within the system.
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

SΣC

1..*

A name associated with the patient
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

Σ

0..1

Text representation of the full name

family

SΣC

0..1

Family name (often called 'Surname')

given

SΣC

0..*

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..*

Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name

suffix

SΣ

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name

Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use

Σ

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

SΣC

1..1

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

SΣ

1..1

The actual contact point details

use

?!SΣ

0..1

home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

rank

Σ

0..1

positiveInt

Specify preferred order of use (1 = highest)

Σ

0..1

Time period when the contact point was/is in use

SΣ

1..1

male | female | other | unknown
Binding: AdministrativeGender (required)

birthDate

SΣC

0..1

date

The date of birth for the individual
FullDateRule: Dates need to be a full date - YYYY-MM-DD

deceased[x]

?!Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

dateTime

SΣ

0..*

An address for the individual

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

Example General: home

Σ

0..1

postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

Example General: both

Σ

0..1

Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132

line

SΣ

0..*

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

city

SΣ

0..1

Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN

district

SΣ

0..1

District name (aka county)
Example General: Madison

state

SΣ

0..1

Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

Example General: OK

postalCode

SΣ

0..1

US Zip Codes
Example General: 9132
Example General: 74047

country

SΣ

0..1

Country (e.g. can be ISO 3166 2 or 3 letter code)

Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

maritalStatus

0..1

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

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

A contact detail for the person

0..1

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

S

1..1

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)

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

other

Σ

1..1

Reference(Patient | RelatedPerson)

The other patient or related person resource that the link refers to

Σ

1..1

Documentation for this format

replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

Terminology Bindings

Path Conformance ValueSet URI

Patient.language

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Patient.identifier.use

IdentifierUse

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1

from the FHIR Standard

Patient.identifier.type

Identifier Type Codes

http://hl7.org/fhir/ValueSet/identifier-type

from the FHIR Standard

Patient.name.use

NameUse

http://hl7.org/fhir/ValueSet/name-use|4.0.1

from the FHIR Standard

Patient.telecom.system

ContactPointSystem

http://hl7.org/fhir/ValueSet/contact-point-system

from the FHIR Standard

Patient.telecom.use

ContactPointUse

http://hl7.org/fhir/ValueSet/contact-point-use

from the FHIR Standard

Patient.gender

http://hl7.org/fhir/ValueSet/administrative-gender

from the FHIR Standard

Patient.address.use

AddressUse

http://hl7.org/fhir/ValueSet/address-use|4.0.1

from the FHIR Standard

Patient.address.type

AddressType

http://hl7.org/fhir/ValueSet/address-type|4.0.1

from the FHIR Standard

Patient.address.state

UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)

http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Patient.maritalStatus

Marital Status Codes

http://hl7.org/fhir/ValueSet/marital-status

from the FHIR Standard

Patient.contact.relationship

PatientContactRelationship

http://hl7.org/fhir/ValueSet/patient-contactrelationship

from the FHIR Standard

Patient.contact.gender

http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

from the FHIR Standard

Patient.communication.language

LanguageCodesWithLanguageAndOptionallyARegionModifier

http://hl7.org/fhir/us/core/ValueSet/simple-language

Patient.link.type

Description & Constraints

LinkType

http://hl7.org/fhir/ValueSet/link-type|4.0.1

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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: 4 elements

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-militaryStatus

Maturity: 3

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints
Patient			USCorePatientProfile(7.0.0)
Slices for extension				Content/Rules for all slices
militaryStatus		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-militaryStatus Binding: https://valueset.x12.org/x217/005010/request/2010C/INS/1/08/00/584 (required): Codes showing the general employment status of an employee/claimant. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
name
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
birthDate	C	0..1	date	The date of birth for the individual FullDateRule: Dates need to be a full date - YYYY-MM-DD
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)
Documentation for this format

Constraints

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	USCorePatientProfile(7.0.0)	Information about an individual or animal receiving health care services
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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 us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.
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
tribalAffiliation		0..*	(Complex)	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
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
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
genderIdentity		0..*	CodeableConcept	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
militaryStatus		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-militaryStatus Binding: https://valueset.x12.org/x217/005010/request/2010C/INS/1/08/00/584 (required): Codes showing the general employment status of an employee/claimant. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	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
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	SΣC	1..*	HumanName	A name associated with the patient us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.
use	?!Σ	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required): The use of a human 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
telecom	Σ	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)
gender	SΣ	1..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	SΣC	0..1	date	The date of birth for the individual FullDateRule: Dates need to be a full date - YYYY-MM-DD
deceased[x]	?!Σ	0..1		𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
use	?!Σ	0..1	code	𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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 Example General: 49 MEADOW ST
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: EVERYTOWN
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. Example General: OK
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132 Example General: 74047
country	SΣ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
communication		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)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient \| RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
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.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.state	extensible	UspsTwoLetterAlphabeticCodes (a valid code from `https://www.usps.com/`) `http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state`
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
FullDateRule	error	Patient.birthDate	Dates need to be a full date - YYYY-MM-DD : $this.toString().length() = 10

Snapshot View

Patient

0..*

USCorePatientProfile(7.0.0)

Information about an individual or animal receiving health care services

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

race

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
us-core-23: If "ASKU" or "UNK" are present, then no other OMB race categories can be present.

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

tribalAffiliation

0..*

(Complex)

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation

birthsex

0..1

Birth Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex

(required): Code for sex assigned at birth

sex

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex

(extensible): Concepts used for general documentation of sex representation

genderIdentity

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity

(extensible)

militaryStatus

0..1

Extension
URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-militaryStatus
Binding: https://valueset.x12.org/x217/005010/request/2010C/INS/1/08/00/584 (required): Codes showing the general employment status of an employee/claimant. These codes are listed within an X12 implementation guide (TR3) and maintained by X12. All X12 work products are copyrighted. See their website for licensing terms and conditions.

?!

0..*

Extensions that cannot be ignored

identifier

SΣ

1..*

Identifier

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

Σ

0..1

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.

SΣ

1..1

The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient

SΣ

1..1

The value that is unique within the system.
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

SΣC

1..*

A name associated with the patient
us-core-6: At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present.

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

Σ

0..1

Text representation of the full name

family

SΣC

0..1

Family name (often called 'Surname')

given

SΣC

0..*

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..*

Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name

suffix

SΣ

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name

Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when name was/is in use

Σ

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A contact detail for the individual

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

SΣC

1..1

phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

SΣ

1..1

The actual contact point details

use

?!SΣ

0..1

home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)

rank

Σ

0..1

positiveInt

Specify preferred order of use (1 = highest)

Σ

0..1

Time period when the contact point was/is in use

SΣ

1..1

male | female | other | unknown
Binding: AdministrativeGender (required)

birthDate

SΣC

0..1

date

The date of birth for the individual
FullDateRule: Dates need to be a full date - YYYY-MM-DD

deceased[x]

?!Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

dateTime

SΣ

0..*

An address for the individual

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

Example General: home

Σ

0..1

postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).

Example General: both

Σ

0..1

Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132

line

SΣ

0..*

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

city

SΣ

0..1

Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN

district

SΣ

0..1

District name (aka county)
Example General: Madison

state

SΣ

0..1

Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

Example General: OK

postalCode

SΣ

0..1

US Zip Codes
Example General: 9132
Example General: 74047

country

SΣ

0..1

Country (e.g. can be ISO 3166 2 or 3 letter code)

Σ

0..1

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

maritalStatus

0..1

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

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

A contact detail for the person

0..1

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

S

1..1

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)

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

other

Σ

1..1

Reference(Patient | RelatedPerson)

The other patient or related person resource that the link refers to

Σ

1..1

Documentation for this format

replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

Terminology Bindings

Path Conformance ValueSet URI

Patient.language

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Patient.identifier.use

IdentifierUse

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1

from the FHIR Standard

Patient.identifier.type

Identifier Type Codes

http://hl7.org/fhir/ValueSet/identifier-type

from the FHIR Standard

Patient.name.use

NameUse

http://hl7.org/fhir/ValueSet/name-use|4.0.1

from the FHIR Standard

Patient.telecom.system

ContactPointSystem

http://hl7.org/fhir/ValueSet/contact-point-system

from the FHIR Standard

Patient.telecom.use

ContactPointUse

http://hl7.org/fhir/ValueSet/contact-point-use

from the FHIR Standard

Patient.gender

http://hl7.org/fhir/ValueSet/administrative-gender

from the FHIR Standard

Patient.address.use

AddressUse

http://hl7.org/fhir/ValueSet/address-use|4.0.1

from the FHIR Standard

Patient.address.type

AddressType

http://hl7.org/fhir/ValueSet/address-type|4.0.1

from the FHIR Standard

Patient.address.state

UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)

http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state

Patient.maritalStatus

Marital Status Codes

http://hl7.org/fhir/ValueSet/marital-status

from the FHIR Standard

Patient.contact.relationship

PatientContactRelationship

http://hl7.org/fhir/ValueSet/patient-contactrelationship

from the FHIR Standard

Patient.contact.gender

http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

from the FHIR Standard

Patient.communication.language

LanguageCodesWithLanguageAndOptionallyARegionModifier

http://hl7.org/fhir/us/core/ValueSet/simple-language

Patient.link.type