US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions

Resource Profile: Debt Portal Patient

Official URL: http://va.gov/fhir/StructureDefinition/DebtPortalPatient Version: 1.10.0
Active as of 2025-11-04 Computable Name: DebtPortalPatient

This StructureDefinition contains the maps for VistA file ACCOUNTS RECEIVABLE (430) to Patient.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Debt Portal«FHIR Account»DebtPortalAccountsubject«FHIR Invoice»DebtPortalInvoicerecipientsubjectissueraccountlineItem[va-charges].chargeItemReferencelineItem[va-interest].chargeItemReference«Patient»DebtPortalPatient«FHIR ChargeItem»DebtPortalChargeItemchargessubjectcontextservice[va-rxorig]service[va-rxrefill]service[va-rxpartial]«FHIR ChargeItem»DebtPortalChargeItemremovedpartOf«FHIR ChargeItem»DebtPortalChargeIteminterest«FHIR PaymentReconciliation»DebtPortalPaymentReconciliationextension[PaymentReconciliation.paymentIssuer].valueReferenceextension[PaymentReconciliation.allocation.target].valueReferencePatientPatientOrganizationPatientEncounterVisitEncounterPTFEncounterMedicationDispenseOriginalMedicationDispenseRefillMedicationDispensePartial

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Constraints: us-core-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race S 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..6 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: raceCategory FHIR (required): see mapping VF_raceCategory
...... extension:detailed 0..* Extension Extended race codes
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
...... extension:text S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
.... extension:ethnicity S 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
...... extension:detailed 0..* Extension Extended ethnicity codes
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
...... extension:text S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
.... extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex . (required): Code for sex assigned at birth
.... extension:genderIdentity S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
..... value[x] S 0..1 CodeableConcept Value of extension
Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
.... extension:patient-religion S 0..1 (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: Religion FHIR (required): see mapping VF_Religion
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... 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
.... identifier:va-icn SΣ 0..1 Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.349
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣC 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
.... 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
Required Pattern: FIRST & MIDDLE
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Required Pattern: SUFFIX
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... 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)
.... telecom:va-home SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: home
.... telecom:va-work SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: work
.... telecom:va-mobile SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: mobile
... gender SΣ 1..1 code male | female | other | unknown
Binding: adminGender FHIR (required): see mapping VF_adminGender
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣC 0..1 dateTime Indicates if the individual is deceased or not
Constraints: p-7-285
... Slices for address SΣ 0..* Address An address for the individual
Slice: Unordered, Open by value:$this
.... address:All Slices Content/Rules for all slices
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-home SΣ 0..1 Address An address for the individual

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Fixed Value: home
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... start SΣC 0..1 dateTime Starting time with inclusive boundary
...... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 HumanName A name associated with the contact person
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given SΣ 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
Required Pattern: FIRST & MIDDLE
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Required Pattern: SUFFIX
.... telecom 0..* ContactPoint A contact detail for the person
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... address 0..1 Address Address for the contact person
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: billing
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... 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)
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
.... display SΣ 0..1 string Text alternative for the resource
Required Pattern: Veterans Health Administration
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:race.​extension:ombCategory.​value[x] Base required OMB Race Categories 📦7.0.0 US Core v7.0
Patient.extension:race.​extension:ombCategory.​value[x].code Base required raceCategory FHIR 📦1.10.0 This IG
Patient.extension:race.​extension:detailed.value[x] Base required Detailed Race 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x] Base required OMB Ethnicity Categories 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x].code Base required ethnicityCategory FHIR 📦1.10.0 This IG
Patient.extension:ethnicity.​extension:detailed.value[x] Base required Detailed ethnicity 📦7.0.0 US Core v7.0
Patient.extension:genderIdentity.​value[x] Base required genderIdentity FHIR 📦1.10.0 This IG
Patient.extension:patient-religion.​value[x] Base required Religion FHIR 📦1.10.0 This IG
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​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.telecom:va-home.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-home.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required adminGender FHIR 📦1.10.0 This IG
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.address:va-home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:va-home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:va-home.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Patient.maritalStatus Base required MaritalStatus FHIR 📦1.10.0 This IG
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.address.​use Base required AddressUse 📍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
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
p-7-285 best practice Patient.deceased[x]:deceasedDateTime If not null then source value from (2-.351) true
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6 error Patient Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
... contact
.... name
..... text S 0..1 string Text representation of the full name
..... family S 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given S 0..* string Given names (not always 'first'). Includes middle names
Required Pattern: FIRST & MIDDLE
..... suffix S 0..* string Parts that come after the name
Required Pattern: SUFFIX
.... telecom
..... value S 0..1 string The actual contact point details
.... address
..... use S 0..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: billing
..... line S 0..* string Street name, number, direction & P.O. Box etc.
..... city S 0..1 string Name of city, town etc.
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Constraints: us-core-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:race S 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..6 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 0..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: raceCategory FHIR (required): see mapping VF_raceCategory
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... extension:detailed 0..* Extension Extended race codes
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
...... extension:text S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
.... extension:ethnicity S 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 0..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... extension:detailed 0..* Extension Extended ethnicity codes
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
...... extension:text S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
.... extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex . (required): Code for sex assigned at birth
.... extension:genderIdentity S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
..... value[x] S 0..1 CodeableConcept Value of extension
Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
.... extension:patient-religion S 0..1 (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: Religion FHIR (required): see mapping VF_Religion
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-icn SΣ 0..1 Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.349
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣC 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
.... 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
Required Pattern: FIRST & MIDDLE
.... prefix Σ 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
Required Pattern: SUFFIX
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-home SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: home
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-work SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-mobile SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: adminGender FHIR (required): see mapping VF_adminGender
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣC 0..1 dateTime Indicates if the individual is deceased or not
Constraints: p-7-285
... Slices for address SΣ 0..* Address An address for the individual
Slice: Unordered, Open by value:$this
.... address:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-home SΣ 0..1 Address An address for the individual

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Fixed Value: home
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start SΣC 0..1 dateTime Starting time with inclusive boundary
...... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given SΣ 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
Required Pattern: FIRST & MIDDLE
..... prefix Σ 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
Required Pattern: SUFFIX
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: billing
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
Required Pattern: Veterans Health Administration
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(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.

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.extension:race.​extension:ombCategory.​value[x] Base required OMB Race Categories 📦7.0.0 US Core v7.0
Patient.extension:race.​extension:ombCategory.​value[x].code Base required raceCategory FHIR 📦1.10.0 This IG
Patient.extension:race.​extension:detailed.value[x] Base required Detailed Race 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x] Base required OMB Ethnicity Categories 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x].code Base required ethnicityCategory FHIR 📦1.10.0 This IG
Patient.extension:ethnicity.​extension:detailed.value[x] Base required Detailed ethnicity 📦7.0.0 US Core v7.0
Patient.extension:genderIdentity.​value[x] Base required genderIdentity FHIR 📦1.10.0 This IG
Patient.extension:patient-religion.​value[x] Base required Religion FHIR 📦1.10.0 This IG
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:va-icn.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​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.telecom:va-home.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-home.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required adminGender FHIR 📦1.10.0 This IG
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.address:va-home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:va-home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:va-home.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Patient.maritalStatus Base required MaritalStatus FHIR 📦1.10.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.contact.address.​type Base required AddressType 📍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.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Patient

Summary

Must-Support: 11 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Constraints: us-core-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race S 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..6 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: raceCategory FHIR (required): see mapping VF_raceCategory
...... extension:detailed 0..* Extension Extended race codes
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
...... extension:text S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
.... extension:ethnicity S 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
...... extension:detailed 0..* Extension Extended ethnicity codes
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
...... extension:text S 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
.... extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex . (required): Code for sex assigned at birth
.... extension:genderIdentity S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
..... value[x] S 0..1 CodeableConcept Value of extension
Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
.... extension:patient-religion S 0..1 (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: Religion FHIR (required): see mapping VF_Religion
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:All Slices Content/Rules for all slices
..... 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
.... identifier:va-icn SΣ 0..1 Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.349
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣC 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
.... 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
Required Pattern: FIRST & MIDDLE
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Required Pattern: SUFFIX
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... 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)
.... telecom:va-home SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: home
.... telecom:va-work SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: work
.... telecom:va-mobile SΣ 0..1 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.
Required Pattern: phone
..... 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)
Required Pattern: mobile
... gender SΣ 1..1 code male | female | other | unknown
Binding: adminGender FHIR (required): see mapping VF_adminGender
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣC 0..1 dateTime Indicates if the individual is deceased or not
Constraints: p-7-285
... Slices for address SΣ 0..* Address An address for the individual
Slice: Unordered, Open by value:$this
.... address:All Slices Content/Rules for all slices
..... 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
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-home SΣ 0..1 Address An address for the individual

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Fixed Value: home
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... start SΣC 0..1 dateTime Starting time with inclusive boundary
...... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 HumanName A name associated with the contact person
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given SΣ 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
Required Pattern: FIRST & MIDDLE
..... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Required Pattern: SUFFIX
.... telecom 0..* ContactPoint A contact detail for the person
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... address 0..1 Address Address for the contact person
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: billing
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... 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)
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
.... display SΣ 0..1 string Text alternative for the resource
Required Pattern: Veterans Health Administration
... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:race.​extension:ombCategory.​value[x] Base required OMB Race Categories 📦7.0.0 US Core v7.0
Patient.extension:race.​extension:ombCategory.​value[x].code Base required raceCategory FHIR 📦1.10.0 This IG
Patient.extension:race.​extension:detailed.value[x] Base required Detailed Race 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x] Base required OMB Ethnicity Categories 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x].code Base required ethnicityCategory FHIR 📦1.10.0 This IG
Patient.extension:ethnicity.​extension:detailed.value[x] Base required Detailed ethnicity 📦7.0.0 US Core v7.0
Patient.extension:genderIdentity.​value[x] Base required genderIdentity FHIR 📦1.10.0 This IG
Patient.extension:patient-religion.​value[x] Base required Religion FHIR 📦1.10.0 This IG
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​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.telecom:va-home.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-home.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required adminGender FHIR 📦1.10.0 This IG
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.address:va-home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:va-home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:va-home.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Patient.maritalStatus Base required MaritalStatus FHIR 📦1.10.0 This IG
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.address.​use Base required AddressUse 📍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
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
p-7-285 best practice Patient.deceased[x]:deceasedDateTime If not null then source value from (2-.351) true
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6 error Patient Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
... contact
.... name
..... text S 0..1 string Text representation of the full name
..... family S 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given S 0..* string Given names (not always 'first'). Includes middle names
Required Pattern: FIRST & MIDDLE
..... suffix S 0..* string Parts that come after the name
Required Pattern: SUFFIX
.... telecom
..... value S 0..1 string The actual contact point details
.... address
..... use S 0..1 code home | work | temp | old | billing - purpose of this address
Required Pattern: billing
..... line S 0..* string Street name, number, direction & P.O. Box etc.
..... city S 0..1 string Name of city, town etc.
..... state S 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode S 0..1 string Postal code for area
..... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* Patient Information about an individual or animal receiving health care services
This profile also complies with the profiles US Core Patient Profile (6.1.0) and US Core Patient Profile (7.0.0)
Constraints: us-core-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:race S 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..6 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Race Categories (required): The 5 race category codes according to the OMB Standards for Maintaining, Collecting, and Presenting Federal Data on Race and Ethnicity, Statistical Policy Directive No. 15, as revised, October 30, 1997.
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 0..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: raceCategory FHIR (required): see mapping VF_raceCategory
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... extension:detailed 0..* Extension Extended race codes
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed Race (required)
...... extension:text S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
.... extension:ethnicity S 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:ombCategory S 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "ombCategory"
....... value[x] 1..1 Coding Value of extension
Binding: OMB Ethnicity Categories (required)
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 0..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code SΣ 0..1 code Symbol in syntax defined by the system
Binding: ethnicityCategory FHIR (required): see mapping VF_ethnicityCategory
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... extension:detailed 0..* Extension Extended ethnicity codes
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "detailed"
....... value[x] 1..1 Coding Value of extension
Binding: Detailed ethnicity (required)
...... extension:text S 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "text"
....... value[x] S 1..1 string Value of extension
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
.... extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex . (required): Code for sex assigned at birth
.... extension:genderIdentity S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
..... value[x] S 0..1 CodeableConcept Value of extension
Binding: genderIdentity FHIR (required): see mapping VF_genderIdentity
.... extension:patient-religion S 0..1 (Complex) The patient's professed religious affiliations
URL: http://hl7.org/fhir/StructureDefinition/patient-religion
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-religion"
..... value[x] S 1..1 CodeableConcept Value of extension
Binding: Religion FHIR (required): see mapping VF_Religion
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for this patient
Slice: Unordered, Open by value:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-icn SΣ 0..1 Identifier An identifier for this patient

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 1..1 CodeableConcept Description of identifier
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:oid:2.16.840.1.113883.4.349
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣ 1..* HumanName A name associated with the patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣC 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
.... 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
Required Pattern: FIRST & MIDDLE
.... prefix Σ 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
Required Pattern: SUFFIX
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint A contact detail for the individual
Slice: Unordered, Open by value:$this
.... telecom:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-home SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: home
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-work SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:va-mobile SΣ 0..1 ContactPoint A contact detail for the individual
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: phone
..... 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)
Required Pattern: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code male | female | other | unknown
Binding: adminGender FHIR (required): see mapping VF_adminGender
... birthDate SΣ 0..1 date The date of birth for the individual
... Slices for deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
.... deceased[x]:deceasedDateTime ?!SΣC 0..1 dateTime Indicates if the individual is deceased or not
Constraints: p-7-285
... Slices for address SΣ 0..* Address An address for the individual
Slice: Unordered, Open by value:$this
.... address:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... address:va-home SΣ 0..1 Address An address for the individual

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 1..1 code home | work | temp | old | billing - purpose of this address
Fixed Value: home
..... type 1..1 code postal | physical | both
Fixed Value: postal
..... text 0..1 string Text representation of the address
..... line 0..* string Street name, number, direction & P.O. Box etc.
..... city 0..1 string Name of city, town etc.
..... district 0..1 string District name (aka county)
..... state 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode 0..1 string Postal code for area
..... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period 0..1 Period Time period when address was/is in use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
..... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.
..... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... start SΣC 0..1 dateTime Starting time with inclusive boundary
...... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... maritalStatus S 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatus FHIR (required): see mapping VF_MaritalStatus
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 0..1 string Family name (often called 'Surname')
Required Pattern: LAST
..... given SΣ 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
Required Pattern: FIRST & MIDDLE
..... prefix Σ 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
Required Pattern: SUFFIX
..... period Σ 0..1 Period Time period when name was/is in use
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
..... value SΣ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Required Pattern: billing
..... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
..... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
..... district Σ 0..1 string District name (aka county)
Example General: Madison
..... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
..... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
..... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 0..1 string Text alternative for the resource
Required Pattern: Veterans Health Administration
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(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.

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.extension:race.​extension:ombCategory.​value[x] Base required OMB Race Categories 📦7.0.0 US Core v7.0
Patient.extension:race.​extension:ombCategory.​value[x].code Base required raceCategory FHIR 📦1.10.0 This IG
Patient.extension:race.​extension:detailed.value[x] Base required Detailed Race 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x] Base required OMB Ethnicity Categories 📦7.0.0 US Core v7.0
Patient.extension:ethnicity.​extension:ombCategory.​value[x].code Base required ethnicityCategory FHIR 📦1.10.0 This IG
Patient.extension:ethnicity.​extension:detailed.value[x] Base required Detailed ethnicity 📦7.0.0 US Core v7.0
Patient.extension:genderIdentity.​value[x] Base required genderIdentity FHIR 📦1.10.0 This IG
Patient.extension:patient-religion.​value[x] Base required Religion FHIR 📦1.10.0 This IG
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:va-icn.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:va-icn.​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.telecom:va-home.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-home.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-work.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom:va-mobile.​use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required adminGender FHIR 📦1.10.0 This IG
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.address:va-home.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address:va-home.​type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address:va-home.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Patient.maritalStatus Base required MaritalStatus FHIR 📦1.10.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.name.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.contact.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.contact.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.contact.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.contact.address.​type Base required AddressType 📍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.managingOrganization.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

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

This structure is derived from Patient

Summary

Must-Support: 11 elements

 

Other representations of profile: CSV, Excel, Schematron