This page is part of the Common Data Models Harmonization FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version.  For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient | 
| Version: | 1.0.0 | 
| Name: | CdmhPatient | 
| Title: | CDMH Patient | 
| Status: | Draft as of 9/1/19 | 
| Definition: | This is the Patient Resource profile for the IG. | 
| Publisher: | HL7 International - Biomedical Research and Regulation Work Group | 
| Copyright: | Used by permission of HL7, all rights reserved Creative Commons License | 
| Source Resource: | XML / JSON / Turtle | 
The official URL for this profile is:
http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePatientProfile
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from USCorePatientProfile
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Patient | 0..* | USCorePatientProfile | CDMH Patient | |
|    id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
|    us-core-race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
|    us-core-ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
|    us-core-birthsex | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
|    patient-genderIdentity | S | 0..1 | CodeableConcept | The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | 
|    cdmh-patient-sexualOrientation | S | 0..1 | code | Sexual Orientation of the Person URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient-sexualOrientation Binding: PCORNet Sexual Orientation (extensible): Sexual Orientation codes to be used by PCORNet data marts | 
|    cdmh-pcornet-race | S | 0..1 | code | PCORNet Race Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-race Binding: PCORNet Race (extensible): Race Codes for PCORNet data marts | 
|    cdmh-pcornet-ethnicity | S | 0..1 | code | PCORNet Ethnicity Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-ethnicity Binding: PCORNet Ethnicity (extensible): Ethnicity Codes for PCORNet data marts | 
|    patient-birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | 
|    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 | |
|     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ΣI | 1..* | HumanName | A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. | 
|     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 | |
|     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ΣI | 0..1 | string | Family name (often called 'Surname') | 
|     given | SΣI | 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 | Σ | 0..* | ContactPoint | A contact detail 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 | |
|     system | SΣI | 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 | 
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | 
|    birthDate | SΣ | 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 | SΣ | 0..* | 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 | |
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | 
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | 
|     text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | 
|     line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | 
|     district | Σ | 0..1 | string | District name (aka county) Example General: Madison | 
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | 
|     postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | 
|     country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|     period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | 
|    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 | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | 
|     id | 0..1 | 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 | 0..* | ContactPoint | A contact detail for the person | |
|     address | 0..1 | Address | Address for the contact person | |
|     gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
|     organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | 
|     period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
|    communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
|     id | 0..1 | string | Unique id for inter-element referencing | |
|     extension | 0..* | Extension | Additional content defined by implementations | |
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | 
|     preferred | 0..1 | boolean | Language preference indicator | |
|    generalPractitioner | S | 0..1 | Reference(US Core Practitioner Profile) | Patient's nominated primary care provider | 
|    managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | 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 | ||||
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Patient | 0..* | USCorePatientProfile | CDMH Patient | |
|    patient-genderIdentity | 0..1 | CodeableConcept | The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | |
|    cdmh-patient-sexualOrientation | 0..1 | code | Sexual Orientation of the Person URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient-sexualOrientation Binding: PCORNet Sexual Orientation (extensible): Sexual Orientation codes to be used by PCORNet data marts | |
|    cdmh-pcornet-race | 0..1 | code | PCORNet Race Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-race Binding: PCORNet Race (extensible): Race Codes for PCORNet data marts | |
|    cdmh-pcornet-ethnicity | 0..1 | code | PCORNet Ethnicity Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-ethnicity Binding: PCORNet Ethnicity (extensible): Ethnicity Codes for PCORNet data marts | |
|    patient-birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
|    identifier | Σ | 1..* | Identifier | An identifier for this patient | 
|     system | Σ | 1..1 | uri | The namespace for the identifier value | 
|     value | Σ | 1..1 | string | The value that is unique within the system. | 
|    name | ΣI | 1..* | HumanName | A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. | 
|     family | ΣI | 0..1 | string | Family name (often called 'Surname') | 
|     given | ΣI | 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 | 
|    telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | 
|     system | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | 
|     value | Σ | 1..1 | string | The actual contact point details | 
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | 
|    gender | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | 
|    birthDate | Σ | 0..1 | date | The date of birth for the individual | 
|    address | Σ | 0..* | Address | An address for the individual | 
|     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 | 
|     city | Σ | 0..1 | string | Name of city, town etc. | 
|     state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | 
|     postalCode | Σ | 0..1 | string | US Zip Codes | 
|     period | Σ | 0..1 | Period | Time period when address was/is in use | 
|    communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
|     language | 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) | |
|    generalPractitioner | 0..1 | Reference(US Core Practitioner Profile) | Patient's nominated primary care provider | |
|    managingOrganization | Σ | 0..1 | Reference(US Core Organization Profile) | Organization that is the custodian of the patient record | 
|  Documentation for this format | ||||
This structure is derived from USCorePatientProfile
Summary
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCorePatientProfile
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Patient | 0..* | USCorePatientProfile | CDMH Patient | |
|    id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
|    us-core-race | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
|    us-core-ethnicity | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
|    us-core-birthsex | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
|    patient-genderIdentity | S | 0..1 | CodeableConcept | The patient's gender identity URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity Binding: GenderIdentity (example) | 
|    cdmh-patient-sexualOrientation | S | 0..1 | code | Sexual Orientation of the Person URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient-sexualOrientation Binding: PCORNet Sexual Orientation (extensible): Sexual Orientation codes to be used by PCORNet data marts | 
|    cdmh-pcornet-race | S | 0..1 | code | PCORNet Race Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-race Binding: PCORNet Race (extensible): Race Codes for PCORNet data marts | 
|    cdmh-pcornet-ethnicity | S | 0..1 | code | PCORNet Ethnicity Code URL: http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-pcornet-ethnicity Binding: PCORNet Ethnicity (extensible): Ethnicity Codes for PCORNet data marts | 
|    patient-birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | 
|    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 | |
|     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ΣI | 1..* | HumanName | A name associated with the patient us-core-8: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. | 
|     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 | |
|     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ΣI | 0..1 | string | Family name (often called 'Surname') | 
|     given | SΣI | 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 | Σ | 0..* | ContactPoint | A contact detail 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 | |
|     system | SΣI | 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 | 
|    gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | 
|    birthDate | SΣ | 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 | SΣ | 0..* | 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 | |
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | 
|     type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | 
|     text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | 
|     line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | 
|     city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | 
|     district | Σ | 0..1 | string | District name (aka county) Example General: Madison | 
|     state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | 
|     postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | 
|     country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | 
|     period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | 
|    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 | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | 
|     id | 0..1 | 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 | 0..* | ContactPoint | A contact detail for the person | |
|     address | 0..1 | Address | Address for the contact person | |
|     gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
|     organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | 
|     period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
|    communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
|     id | 0..1 | string | Unique id for inter-element referencing | |
|     extension | 0..* | Extension | Additional content defined by implementations | |
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | 
|     preferred | 0..1 | boolean | Language preference indicator | |
|    generalPractitioner | S | 0..1 | Reference(US Core Practitioner Profile) | Patient's nominated primary care provider | 
|    managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | 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 | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | 
| Patient.language | preferred | CommonLanguages Max Binding: AllLanguages | 
| Patient.identifier.use | required | IdentifierUse | 
| Patient.identifier.type | extensible | Identifier Type Codes | 
| Patient.name.use | required | NameUse | 
| Patient.telecom.system | required | ContactPointSystem | 
| Patient.telecom.use | required | ContactPointUse | 
| Patient.gender | required | AdministrativeGender | 
| Patient.address.use | required | AddressUse | 
| Patient.address.type | required | AddressType | 
| Patient.address.state | extensible | UspsTwoLetterAlphabeticCodes | 
| Patient.maritalStatus | extensible | Marital Status Codes | 
| Patient.contact.relationship | extensible | PatientContactRelationship | 
| Patient.contact.gender | required | AdministrativeGender | 
| Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier | 
| Patient.link.type | required | LinkType | 
| Id | Path | Details | Requirements | 
| dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:birthsex | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:birthsex | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:genderIdentity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:genderIdentity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:sexualOrientation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:sexualOrientation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:pcornet-race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:pcornet-race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:pcornet-ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:pcornet-ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:birthTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:birthTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| us-core-8 | 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() | |
| ele-1 | Patient.name.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.name.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.name.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.family | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.given | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.prefix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.suffix | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.name.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.telecom.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.telecom.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.telecom.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| pat-1 | 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() | |
| ele-1 | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |