Central Cancer Registry Reporting Content IG
1.0.0 - STU 1 United States of America flag

Central Cancer Registry Reporting Content IG, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-central-cancer-registry-reporting-ig/ and changes regularly. See the Directory of published versions

Resource Profile: US Public Health Patient

Official URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-patient Version: 1.0.0
Active as of 2024-03-20 Computable Name: USPublicHealthPatient

This Patient profile represents a US Public Health Patient.

This proile is present in the IG to synchronize with common Patient profile being developed by public health profiles library IG. This profile is being used by the Cancer Patient profile. Implementers of the IG are expected to implement only the Cancer Patient profile. It is based on the US Core Patient profile with further restrictions to allow masking of some data elements and the addition of the patient-genderIdentity extension.

For ONC’s USCDI requirements, it adds Must Support constraints to the following:

  • contact detail (e.g. a telephone number or an email address)
  • a communication language
  • a race
  • an ethnicity
  • a birth sex

Usage:

Formal Views of Profile Content

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

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileUS Public Health Patient
... extension:race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:ethnicity S0..1USCoreEthnicityExtensionUS Core ethnicity Extension
... extension:birthsex S0..1USCoreBirthSexExtensionExtension
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... identifier S1..*IdentifierAn identifier for this patient
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... name 1..*HumanNameA name associated with the patient
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... Slices for telecom S1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom:phone S0..*ContactPointA contact detail for the individual
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the individual
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... gender S1..1codemale | female | other | unknown
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... birthDate S1..1dateThe date of birth for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
.... district S0..1stringCounty
... contact S0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship S1..1CodeableConceptThe kind of relationship
.... name S0..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom S0..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... address S0..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileUS Public Health Patient
us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... birthDate SΣ1..1dateThe date of birth for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S0..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... telecom S0..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S0..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / CodeURI
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6errorPatientEither 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileUS Public Health Patient
us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... value 0..1stringPrimitive value for code
... birthDate SΣ1..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S0..1HumanNameA name associated with the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointA contact detail for the person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressAddress for the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6errorPatientEither 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 USCorePatientProfile

Summary

Mandatory: 5 elements (13 nested mandatory elements)
Must-Support: 42 elements
Fixed Value: 12 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.telecom is sliced based on the value of value:system

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*USCorePatientProfileUS Public Health Patient
... extension:race S0..1USCoreRaceExtensionUS Core Race Extension
... extension:ethnicity S0..1USCoreEthnicityExtensionUS Core ethnicity Extension
... extension:birthsex S0..1USCoreBirthSexExtensionExtension
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... identifier S1..*IdentifierAn identifier for this patient
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... name 1..*HumanNameA name associated with the patient
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... Slices for telecom S1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom:phone S0..*ContactPointA contact detail for the individual
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
.... telecom:email S0..*ContactPointA contact detail for the individual
..... system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: email
... gender S1..1codemale | female | other | unknown
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... birthDate S1..1dateThe date of birth for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... value[x] S1..1codeValue of extension
Fixed Value: masked
.... district S0..1stringCounty
... contact S0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
.... relationship S1..1CodeableConceptThe kind of relationship
.... name S0..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... telecom S0..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
.... address S0..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... value[x] S1..1codeValue of extension
Fixed Value: masked

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileUS Public Health Patient
us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... birthDate SΣ1..1dateThe date of birth for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S0..1HumanNameA name associated with the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... telecom S0..*ContactPointA contact detail for the person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... address S0..1AddressAddress for the contact person
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / CodeURI
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6errorPatientEither 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileUS Public Health Patient
us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... race S0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity S0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... birthsex S0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity S0..*(Complex)The individual's gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... tribalAffiliation S0..*(Complex)Tribal affiliation and membership of the patient
URL: http://hl7.org/fhir/us/central-cancer-registry-reporting/StructureDefinition/us-ph-tribal-affiliation-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason 0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... Slices for telecom SΣ1..*ContactPointA contact detail for the individual
Slice: Unordered, Open by value:system
.... telecom:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:phone SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... telecom:email SΣ0..*ContactPointA contact detail for the individual
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: email
..... value SΣ1..1stringThe actual contact point details
..... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... value 0..1stringPrimitive value for code
... birthDate SΣ1..1dateThe date of birth for the individual
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ1..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
..... id 0..1idUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
..... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringCounty
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact SC0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship S1..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name S0..1HumanNameA name associated with the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

..... text Σ0..1stringText representation of the full name
..... family Σ0..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom S0..*ContactPointA contact detail for the person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value Σ0..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
.... address S0..1AddressAddress for the contact person
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... dataAbsentReason S0..1codeunknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
...... value[x] S1..1codeValue of extension
Binding: DataAbsentReason (required)
Fixed Value: masked
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringPlain text representation of the concept
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / CodeURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:phone.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:phone.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.telecom:email.systemrequiredFixed Value: email
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Patient.telecom:email.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Patient.gender.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.birthDate.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.name.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Patient.contact.telecom.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.address.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.contact.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.contact.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.communication.language.extension:dataAbsentReason.value[x]requiredFixed Value: masked
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6errorPatientEither 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 USCorePatientProfile

Summary

Mandatory: 5 elements (13 nested mandatory elements)
Must-Support: 42 elements
Fixed Value: 12 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.telecom is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron