Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot
Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide
1.0.0-ballot - STU1 Ballot
This page is part of the Respiratory Virus Hospitalization Surveillance Network (RESP-NET) Content Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/resp-net/StructureDefinition/us-ph-patient | Version: 1.0.0-ballot | |||
| Active as of 2023-12-21 | Computable Name: USPublicHealthPatient | |||
This Patient profile represents a US Public Health Patient.
This profile 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 RESP-NET Patient profile. Implementers of the IG are expected to implement only the RESP-NET 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:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | USCorePatientProfile | US Public Health Patient | |
  extension:race | S | 0..1 | USCoreRaceExtension | US Core Race Extension |
| extension:ethnicity | S | 0..1 | USCoreEthnicityExtension | US Core ethnicity Extension |
| extension:birthsex | S | 0..1 | USCoreBirthSexExtension | Extension |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
  identifier | S | 1..* | Identifier | An identifier for this patient |
  dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
   value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| name | 1..* | HumanName | A name associated with the patient | |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
 Slices for telecom | S | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
 telecom:All Slices | Content/Rules for all slices | |||
  dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| telecom:phone | S | 0..* | ContactPoint | A contact detail for the individual |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
| telecom:email | S | 0..* | ContactPoint | A contact detail for the individual |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| gender | S | 1..1 | code | male | female | other | unknown |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| birthDate | S | 1..1 | date | The date of birth for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |
| address | S | 1..* | Address | An address for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
 district | S | 0..1 | string | County |
| contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| relationship | S | 1..1 | CodeableConcept | The kind of relationship |
| name | S | 0..1 | HumanName | A name associated with the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| address | S | 0..1 | Address | Address for the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | USCorePatientProfile | US Public Health Patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| race | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
| ethnicity | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 1..* | Identifier | An identifier for this patient |
| dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
  extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | SΣC | 1..* | HumanName | A name associated with the patient |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family | SΣC | 0..1 | string | Family name (often called 'Surname') |
| given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for telecom | SΣ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
| telecom:All Slices | Content/Rules for all slices | |||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
 system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
 use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:phone | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:email | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| birthDate | SΣ | 1..1 | date | The date of birth for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
 deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | SΣ | 1..* | Address | An address for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district | SΣ | 0..1 | string | County Example General: Madison |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. |
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
| name | S | 0..1 | HumanName | A name associated with the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address | S | 0..1 | Address | Address for the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.identifier.use | required | IdentifierUse |
| Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.name.use | required | NameUse |
| Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.telecom.system | required | ContactPointSystem |
| Patient.telecom.use | required | ContactPointUse |
| Patient.telecom:phone.system | required | Fixed Value: phone |
| Patient.telecom:phone.use | required | ContactPointUse |
| Patient.telecom:email.system | required | Fixed Value: email |
| Patient.telecom:email.use | required | ContactPointUse |
| Patient.gender | required | AdministrativeGender |
| Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.address.use | required | AddressUse |
| Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.name.use | required | NameUse |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.telecom.use | required | ContactPointUse |
| Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.address.use | required | AddressUse |
| Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier |
| Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| us-core-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | USCorePatientProfile | US Public Health Patient | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| race | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
| ethnicity | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
| birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | SΣC | 1..* | HumanName | A name associated with the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
| given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | SΣ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:phone | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:email | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| value | 0..1 | date | Primitive value for date | |||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | SΣ | 1..* | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | SΣ | 0..1 | string | County Example General: Madison | ||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
| name | S | 0..1 | HumanName | A name associated with the contact person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | S | 0..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | S | 0..1 | Address | Address for the contact person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | extensible | Identifier Type Codes | ||||
| Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.name.use | required | NameUse | ||||
| Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.telecom:phone.system | required | Fixed Value: phone | ||||
| Patient.telecom:phone.use | required | ContactPointUse | ||||
| Patient.telecom:email.system | required | Fixed Value: email | ||||
| Patient.telecom:email.use | required | ContactPointUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.name.use | required | NameUse | ||||
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.telecom.system | required | ContactPointSystem | ||||
| Patient.contact.telecom.use | required | ContactPointUse | ||||
| Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.address.use | required | AddressUse | ||||
| Patient.contact.address.type | required | AddressType | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier | ||||
| Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| us-core-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or 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: 40 elements
Fixed Value: 12 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCorePatientProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | USCorePatientProfile | US Public Health Patient | |
| extension:race | S | 0..1 | USCoreRaceExtension | US Core Race Extension |
| extension:ethnicity | S | 0..1 | USCoreEthnicityExtension | US Core ethnicity Extension |
| extension:birthsex | S | 0..1 | USCoreBirthSexExtension | Extension |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| identifier | S | 1..* | Identifier | An identifier for this patient |
| dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| name | 1..* | HumanName | A name associated with the patient | |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| Slices for telecom | S | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
| telecom:All Slices | Content/Rules for all slices | |||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| telecom:phone | S | 0..* | ContactPoint | A contact detail for the individual |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
| telecom:email | S | 0..* | ContactPoint | A contact detail for the individual |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
| gender | S | 1..1 | code | male | female | other | unknown |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| birthDate | S | 1..1 | date | The date of birth for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |
| address | S | 1..* | Address | An address for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| district | S | 0..1 | string | County |
| contact | S | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| relationship | S | 1..1 | CodeableConcept | The kind of relationship |
| name | S | 0..1 | HumanName | A name associated with the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| address | S | 0..1 | Address | Address for the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| value[x] | S | 1..1 | code | Value of extension Fixed Value: masked |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | USCorePatientProfile | US Public Health Patient | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| race | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
| ethnicity | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth |
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | An identifier for this patient |
| dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| name | SΣC | 1..* | HumanName | A name associated with the patient |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family | SΣC | 0..1 | string | Family name (often called 'Surname') |
| given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| Slices for telecom | SΣ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system |
| telecom:All Slices | Content/Rules for all slices | |||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:phone | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| telecom:email | SΣ | 0..* | ContactPoint | A contact detail for the individual |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| birthDate | SΣ | 1..1 | date | The date of birth for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | SΣ | 1..* | Address | An address for the individual |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| district | SΣ | 0..1 | string | County Example General: Madison |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. |
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. |
| name | S | 0..1 | HumanName | A name associated with the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address | S | 0..1 | Address | Address for the contact person |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) |
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked |
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.identifier.use | required | IdentifierUse |
| Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.name.use | required | NameUse |
| Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.telecom.system | required | ContactPointSystem |
| Patient.telecom.use | required | ContactPointUse |
| Patient.telecom:phone.system | required | Fixed Value: phone |
| Patient.telecom:phone.use | required | ContactPointUse |
| Patient.telecom:email.system | required | Fixed Value: email |
| Patient.telecom:email.use | required | ContactPointUse |
| Patient.gender | required | AdministrativeGender |
| Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.address.use | required | AddressUse |
| Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) |
| Patient.contact.relationship | extensible | PatientContactRelationship |
| Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.name.use | required | NameUse |
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.telecom.use | required | ContactPointUse |
| Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.contact.address.use | required | AddressUse |
| Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier |
| Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked |
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| us-core-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | USCorePatientProfile | US Public Health Patient | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| race | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
| ethnicity | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
| birthsex | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
| birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for this patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name | SΣC | 1..* | HumanName | A name associated with the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣC | 0..1 | string | Family name (often called 'Surname') | ||||
| given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| Slices for telecom | SΣ | 1..* | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:system | ||||
| telecom:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:phone | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| telecom:email | SΣ | 0..* | ContactPoint | A contact detail for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| value | 0..1 | string | Primitive value for code | |||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| value | 0..1 | date | Primitive value for date | |||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | SΣ | 1..* | Address | An address for the individual | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | SΣ | 0..1 | string | County Example General: Madison | ||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean | boolean | |||||||
| multipleBirthInteger | integer | |||||||
| photo | 0..* | Attachment | Image of the patient | |||||
| contact | SC | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship | S | 1..1 | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | ||||
| name | S | 0..1 | HumanName | A name associated with the contact person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | S | 0..* | ContactPoint | A contact detail for the person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | S | 0..1 | Address | Address for the contact person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| dataAbsentReason | S | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||
| value[x] | S | 1..1 | code | Value of extension Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. Fixed Value: masked | ||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
| link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.identifier.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | extensible | Identifier Type Codes | ||||
| Patient.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.name.use | required | NameUse | ||||
| Patient.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.telecom.system | required | ContactPointSystem | ||||
| Patient.telecom.use | required | ContactPointUse | ||||
| Patient.telecom:phone.system | required | Fixed Value: phone | ||||
| Patient.telecom:phone.use | required | ContactPointUse | ||||
| Patient.telecom:email.system | required | Fixed Value: email | ||||
| Patient.telecom:email.use | required | ContactPointUse | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.gender.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.birthDate.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.address.use | required | AddressUse | ||||
| Patient.address.type | required | AddressType | ||||
| Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/) | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.name.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.name.use | required | NameUse | ||||
| Patient.contact.telecom.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.telecom.system | required | ContactPointSystem | ||||
| Patient.contact.telecom.use | required | ContactPointUse | ||||
| Patient.contact.address.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.contact.address.use | required | AddressUse | ||||
| Patient.contact.address.type | required | AddressType | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier | ||||
| Patient.communication.language.extension:dataAbsentReason.value[x] | required | Fixed Value: masked | ||||
| Patient.link.type | required | LinkType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() | |
| us-core-8 | error | Patient.name | Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or 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: 40 elements
Fixed Value: 12 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Public Health. Package hl7.fhir.us.resp-net#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change