LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/cdm-patient | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: CDMPatient | |||
LinuxForHealth Common Data Model definition of what fields we currently define for a patient
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
  meta | 0..1 | ProcessMeta | Metadata about a resource | |
 contained | 0..0 | |||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |
 patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |
  valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |
| valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |
| type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
 value | 1..1 | string | The value that is unique | |
| telecom | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| contact | ||||
| telecom | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..1 | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| communication | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| languageRank | 0..1 | positiveInt | Specify preferred order of language use (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/language-rank | |
 generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:patientImportance.valueCodeableConcept | extensible | PatientImportanceValueSet |
| Patient.extension:patientCitizenship.valueCodeableConcept | extensible | CitizenshipValueSet |
| Patient.extension:patientGenderIdentity.valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) |
| Patient.identifier.type | extensible | IdentifierTypeValueSet |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |
| patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |
  Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
  value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship" | |
| Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |
| encryptedState | 0..1 | boolean | Used to indicate whether the identifier value is encrypted URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/encrypted-state | |
| 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 Value Set (extensible) |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
 deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |
 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 |
| Patient.extension:patientImportance.value[x]:valueCodeableConcept | extensible | PatientImportanceValueSet |
| Patient.extension:patientCitizenship.value[x]:valueCodeableConcept | extensible | CitizenshipValueSet |
| Patient.extension:patientGenderIdentity.value[x] | example | GenderIdentity |
| Patient.extension:patientGenderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | extensible | IdentifierTypeValueSet |
| Patient.link.type | required | LinkType |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | 0..1 | ProcessMeta | Metadata about a 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 | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |||||
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |||||
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |||||
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |||||
| patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |||||
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |||||
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship" | |||||
| Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |||||
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |||||
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |||||
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |||||
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |||||
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |||||
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |||||
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |||||
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |||||
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |||||
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |||||
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |||||
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |||||
| 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 | |||||
| encryptedState | 0..1 | boolean | Used to indicate whether the identifier value is encrypted URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/encrypted-state | |||||
| 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 Value Set (extensible) | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique 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 | Σ | 0..* | HumanName | A name associated with the patient | ||||
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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 | C | 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 | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| address | 0..1 | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| languageRank | 0..1 | positiveInt | Specify preferred order of language use (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/language-rank | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |||||
| 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 | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:patientImportance.value[x]:valueCodeableConcept | extensible | PatientImportanceValueSet | ||||
| Patient.extension:patientCitizenship.value[x]:valueCodeableConcept | extensible | CitizenshipValueSet | ||||
| Patient.extension:patientGenderIdentity.value[x] | example | GenderIdentity | ||||
| Patient.extension:patientGenderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) | ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | extensible | IdentifierTypeValueSet | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
This structure is derived from Patient
Summary
Mandatory: 0 element (3 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| contained | 0..0 | |||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |
| patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |
| valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |
| type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
| value | 1..1 | string | The value that is unique | |
| telecom | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| contact | ||||
| telecom | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..1 | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| communication | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| languageRank | 0..1 | positiveInt | Specify preferred order of language use (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/language-rank | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Patient.extension:patientImportance.valueCodeableConcept | extensible | PatientImportanceValueSet |
| Patient.extension:patientCitizenship.valueCodeableConcept | extensible | CitizenshipValueSet |
| Patient.extension:patientGenderIdentity.valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) |
| Patient.identifier.type | extensible | IdentifierTypeValueSet |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |
| patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship" | |
| Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |
| encryptedState | 0..1 | boolean | Used to indicate whether the identifier value is encrypted URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/encrypted-state | |
| 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 Value Set (extensible) |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |
| 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 |
| Patient.extension:patientImportance.value[x]:valueCodeableConcept | extensible | PatientImportanceValueSet |
| Patient.extension:patientCitizenship.value[x]:valueCodeableConcept | extensible | CitizenshipValueSet |
| Patient.extension:patientGenderIdentity.value[x] | example | GenderIdentity |
| Patient.extension:patientGenderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) |
| Patient.identifier.use | required | IdentifierUse |
| Patient.identifier.type | extensible | IdentifierTypeValueSet |
| Patient.link.type | required | LinkType |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | 0..1 | ProcessMeta | Metadata about a 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 | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| ethnicity | 0..1 | CodeableConcept | Code for the ethnicity of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/ethnicity | |||||
| familyId | 0..* | Identifier | The unique identifier for the subscriber (contract holder, employee) and the associated dependents URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/family-id | |||||
| usCoreBirthSex | 0..1 | code | A code classifying the person’s sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC) URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
| usCoreRace | 0..1 | (Complex) | Complex extension for race allows one or more race codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
| usCoreEthnicity | 0..1 | (Complex) | Complex extension for ethnicity allows one or more ethnicity codes URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
| immigrationStatus | 0..1 | CodeableConcept | Customer-specific code for the immigration status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/immigration-status | |||||
| statusCode | 0..* | CodeableConcept | Customer-specific patient status codes URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/status-code Binding: Patient Status Value Set (example) | |||||
| patientImportance | 0..1 | CodeableConcept | The importance of the patient. For example: VIP, DO-NOT-CONTACT, etc. URL: http://hl7.org/fhir/StructureDefinition/patient-importance | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-importance" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Patient Importance Value Set (extensible) | |||||
| localRaceCd | 0..1 | CodeableConcept | Customer-specific code for the race of the person URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/local-race-cd | |||||
| patientCitizenship | 0..* | CodeableConcept | Code to identify if the patient is a U.S. Citizen URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://linuxforhealth.org/fhir/cdm/StructureDefinition/patient-citizenship" | |||||
| Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Binding: Citizenship Value Set (extensible) | |||||
| citizenStatus | 0..1 | CodeableConcept | Customer-specific code for the citizenship status of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/citizen-status | |||||
| sexAssignedAtBirth | 0..1 | CodeableConcept | Sex assigned at birth based on observation by a physician. Also called phenotype, or how the genes were expressed, based on the observation of the doctor. This assignment may not match the gender Identity of the person, which will not be known until the newborn is older. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sex-assigned-at-birth Binding: Sex Assigned At Birth Value Set (extensible) | |||||
| patientGenderIdentity | 0..1 | CodeableConcept | The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this Binding: GenderIdentity (example) | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set (extensible) | |||||
| identifiedPronouns | 0..* | string | Gender, typically described in terms of masculinity and femininity, is a social construction that varies across different cultures and over time. This value is often used for identity purposes and should be collected directly from the patient. URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/identified-pronouns | |||||
| legallyDocumentedSex | 0..1 | (Complex) | Sex as defined or amended on the patient's legal documentation, for example a birth certificate or driver's license URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/legally-documented-sex | |||||
| sexualOrientation | 0..1 | CodeableConcept | Patient's physical, romantic, and/or emotional attraction towards other people URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/sexual-orientation Binding: Sexual Orientation Value Set (extensible) | |||||
| communicationOptOut | 0..* | (Complex) | Opt-out patient for communications by product and/or communication mode URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/communication-opt-out | |||||
| nonstandardLanguage | 0..1 | CodeableConcept | Code for the language of the patient URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/nonstandard-language | |||||
| veteranIndicator | 0..1 | string | Indicates whether the individual served in the active military, naval, or air service URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/veteran-indicator | |||||
| snapshotAgeInWeeks | 0..1 | unsignedInt | Age in weeks of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-weeks | |||||
| snapshotAgeInMonths | 0..1 | unsignedInt | Age in months of the patient at a point in time URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-in-months | |||||
| snapshotAgeCalculated | 0..1 | dateTime | Date indicating when the age fields were calculated URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/snapshot-age-calculated | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | CDMIdentifier | An identifier intended for computation | |||||
| 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 | |||||
| encryptedState | 0..1 | boolean | Used to indicate whether the identifier value is encrypted URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/encrypted-state | |||||
| 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 Value Set (extensible) | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique 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 | Σ | 0..* | HumanName | A name associated with the patient | ||||
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean | boolean | |||||||
| deceasedDateTime | dateTime | |||||||
| address | 0..* | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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 | C | 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 | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name | 0..1 | HumanName | A name associated with the contact person | |||||
| telecom | C | 0..* | CDMContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| address | 0..1 | CDMAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| languageRank | 0..1 | positiveInt | Specify preferred order of language use (1 = highest) URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/language-rank | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred | 0..1 | boolean | Language preference indicator | |||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | A reference from one resource to another | |||||
| 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 | ||||
| Patient.language | preferred | CommonLanguages
| ||||
| Patient.extension:patientImportance.value[x]:valueCodeableConcept | extensible | PatientImportanceValueSet | ||||
| Patient.extension:patientCitizenship.value[x]:valueCodeableConcept | extensible | CitizenshipValueSet | ||||
| Patient.extension:patientGenderIdentity.value[x] | example | GenderIdentity | ||||
| Patient.extension:patientGenderIdentity.value[x]:valueCodeableConcept | extensible | GenderIdentityValueSet (a valid code from Gender Identity Codes) | ||||
| Patient.identifier.use | required | IdentifierUse | ||||
| Patient.identifier.type | extensible | IdentifierTypeValueSet | ||||
| Patient.gender | required | AdministrativeGender | ||||
| Patient.maritalStatus | extensible | Marital Status Codes | ||||
| Patient.contact.relationship | extensible | PatientContactRelationship | ||||
| Patient.contact.gender | required | AdministrativeGender | ||||
| Patient.communication.language | preferred | CommonLanguages
| ||||
| Patient.link.type | required | LinkType |
This structure is derived from Patient
Summary
Mandatory: 0 element (3 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron