| Left: | Patient - Child - Vital Records (http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr) |
| Right: | Patient - Vital Records (http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-vr) |
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr' vs 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-vr' |
| Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '2.0.0-ballot' |
| Information | StructureDefinition.name | Values for name differ: 'PatientChildVitalRecords' vs 'PatientVitalRecords' |
| Information | StructureDefinition.title | Values for title differ: 'Patient - Child - Vital Records' vs 'Patient - Vital Records' |
| Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' |
| Information | StructureDefinition.date | Values for date differ: '2023-10-06T12:31:03+00:00' vs '2023-12-16T21:52:39+00:00' |
| Warning | StructureDefinition.abstract | Values for abstract differ: 'false' vs 'true' |
| Information | Patient.extension | Element minimum cardinalities differ: '1' vs '0' |
| Information | Patient.name.use | Element minimum cardinalities differ: '0' vs '1' |
| Information | Patient.birthDate | Element minimum cardinalities differ: '1' vs '0' |
| Information | StructureDefinition.short | Values for short differ: 'Indicates if the individual is deceased or not, dateTime is preferred' vs 'Indicates if the individual is deceased or not' |
| Warning | Patient.deceased[x] | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | StructureDefinition.short | Values for short differ: 'If not single delivery- born first, second, third, etc.' vs 'If not single birth - born first, second, third, etc.' |
| Information | StructureDefinition.definition | Values for definition differ: 'If not single delivery, specify delivered 1st, 2nd, etc. – for multiple deliveries, the order this infant was delivered in the set. Include all live births and fetal losses.' vs 'If not single birth, specify born 1st, 2nd, etc. – For multiple deliveries, the order this infant was delivered in the set. Include all live births and fetal losses.' |
| Warning | Patient.multipleBirth[x] | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | StructureDefinition.short | Values for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing' |
| Information | StructureDefinition.definition | Values for definition differ: 'unique id for the element within a resource (for internal references)' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.' |
| Information | StructureDefinition.short | Values for short differ: 'Extension' vs 'Additional content defined by implementations' |
| Information | StructureDefinition.definition | Values for definition differ: 'An Extension' vs 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' |
| Name | Value | Comments | |
|---|---|---|---|
 abstract | false | true |
|
| baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||
| copyright | |||
| date | 2023-10-06T12:31:03+00:00 | 2023-12-16T21:52:39+00:00 |
|
| description | This Patient profile represents the subject patient (newborn/infant/child) for whom clinical data is included in the report. | This abstract Patient profile includes common extensions and slicing used across vital records. |
|
| experimental | |||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
 jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | PatientChildVitalRecords | PatientVitalRecords |
|
| publisher | HL7 International / Public Health | ||
| purpose | |||
| status | active | draft |
|
| title | Patient - Child - Vital Records | Patient - Vital Records |
|
| type | Patient | ||
| url | http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr | http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-vr |
|
| version | 1.1.0 | 2.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Patient | C | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | C | 0..* | USCorePatientProfile | This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords, PatientDecedentFetus Information about an individual or animal receiving health care services | |||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
 Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 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 | 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: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (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 | 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 | 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 | Σ | 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) | Σ | 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 | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | |||||||||
| name | SΣ | 1..* | HumanName | A name associated with the patient | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 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: ?? (required): The use of a human name. | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. |
| ||||||||
| text | Σ | 0..1 | string | Text representation of the full name | Σ | 0..1 | string | Text representation of the full name | |||||||||
| family | SΣC | 1..1 | string | Family name (often called 'Surname') | SΣC | 1..1 | string | Family name (often called 'Surname') | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||||||||
| given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||||||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | Σ | 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 | Σ | 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 | Σ | 0..1 | Period | Time period when name was/is in use | |||||||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | Σ | 0..* | ContactPoint | A contact detail for the individual | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. | |||||||||
| value | SΣ | 1..1 | string | The actual contact point details | 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: ?? (required) | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required) | |||||||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: ?? (required) | SΣ | 1..1 | code | male | female | other | unknown Binding: ?? (required) | |||||||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | SΣ | 0..1 | date | The date of birth for the individual |
| ||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| value | 0..1 | date | Primitive value for date | 0..1 | date | Primitive value for date | |||||||||||
| deceased[x] | ?!SΣ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
| ||||||||
| address | SΣ | 0..* | Address | An address for the individual | SΣ | 0..* | Address | An address for the individual | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 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 | 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: ?? (required): The use of an address. Example General: home | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home | |||||||||
| type | Σ | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both | Σ | 0..1 | code | postal | physical | both Binding: ?? (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 | Σ | 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 | 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 | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) |
| |||||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| |||||||||||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 |
| |||||||||||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) |
| |||||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| |||||||||||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 |
| |||||||||||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two Letter USPS alphabetic codes. | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (required) | |||||||||
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | 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) | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ?? (required) | |||||||||
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | 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: ?? (extensible): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: ?? (extensible): The domestic partnership status of a person. | |||||||||||
| multipleBirth[x] | S | 0..1 | integer | If not single delivery- born first, second, third, etc. | 0..1 | boolean, integer | If not single birth - born first, second, third, etc. |
| |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| value | 0..1 | integer | Primitive value for integer |
| |||||||||||||
| photo | 0..* | Attachment | Image of the patient | 0..* | Attachment | Image of the patient | |||||||||||
| contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: ?? (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: ?? (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 | 0..1 | HumanName | A name associated with the contact person | |||||||||||
| telecom | 0..* | ContactPoint | A contact detail for the person | 0..* | ContactPoint | A contact detail for the person | |||||||||||
| address | 0..1 | Address | Address for the contact person | 0..1 | Address | Address for the contact person | |||||||||||
| gender | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||||
| organization | C | 0..1 | Reference(Organization) | Organization that is associated with the contact | 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 | 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 | 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 | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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: ?? (extensible) | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (extensible) | |||||||||
| preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | Σ | 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 | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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 | Σ | 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: ?? (required): The type of link between this patient resource and another patient resource. | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: ?? (required): The type of link between this patient resource and another patient resource. | |||||||||
| Documentation for this format | |||||||||||||||||