UV_Vital Records Birth and Fetal Death Reporting
1.1.0 - STU 1.1
UV_Vital Records Birth and Fetal Death Reporting, published by IHE International. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/fhir-bfdr/ and changes regularly. See the Directory of published versions
Official URL: https://profiles.ihe.net/QRPH/bfdr/StructureDefinition/Encounter-maternity | Version: 1.1.0 | |||
Active as of 2024-07-09 | Computable Name: EncounterMaternity |
This Encounter profile represents the mother’s maternity encounter.
After the child is born, an Encounter record will be created for the child (Encounter-Birth) and will reference this encounter using the partOf property.
This profile is mapped to:
Use Case | IJE Field# | Description | IJE Name | Field |
---|---|---|---|---|
Natality | 302 | Facility Mother Moved From (if transferred) | HOSPFROM | hospitalization.origin |
Natality | 125 | Mother Transferred? | TRAN | Encounter-maternity.hospitalization.admitSource |
Fetal Death | 231 | Place of Delivery Street Address | ADDRESS_D | address |
Fetal Death | 230 | Place of Delivery Unit or Apartment Number | APTNUMB_D | location.location.address |
Fetal Death | 349 | Date Signed by Certifier–Day | CERTIFIED_DY | participant:certifier.period.start |
Fetal Death | 348 | Date Signed by Certifier–Month | CERTIFIED_MO | participant:certifier.period.start |
Fetal Death | 347 | Date Signed by Certifier–Year | CERTIFIED_YR | participant:certifier.period.start |
Fetal Death | 234 | Place of Delivery City/Town/Place (literal) | CITY_D | location.location.address |
Fetal Death | 233 | Place of Delivery County (literal) | CNTY_D | location.location.address |
Fetal Death | 236 | Place of Delivery Country (literal) | COUNTRY_D | location.location.address |
Fetal Death | 11 | Place Where Delivery Occurred | DPLACE | location.physicalType |
Fetal Death | 12 | Facility ID (NPI) - If available | FNPI | location.identifier |
Fetal Death | 224 | Name of Delivery Facility | HOSP_D | name |
Fetal Death | 339 | Facility Mother Moved From (if transferred) | HOSPFROM | hospitalization.origin |
Fetal Death | 229 | Place of Delivery Post Directional | POSTDIR_D | location.location.address |
Fetal Death | 226 | Place of Delivery Pre Directional | PREDIR_D | location.location.address |
Fetal Death | 13 | Facility ID (State-Assigned) | SFN | identifer |
Fetal Death | 235 | State, U.S. Territory or Canadian Province of Place of Delivery - literal | STATE_D | location.location.address |
Fetal Death | 228 | Place of Delivery Street designator | STDESIG_D | location.location.address |
Fetal Death | 227 | Place of Delivery Street name | STNAME_D | location.location.address |
Fetal Death | 225 | Place of Delivery Street number | STNUM_D | location.location.address |
Fetal Death | 232 | Place of Delivery Zip code and Zip+4 | ZIPCODE_D | location.location.address |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |
identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
class | S | 1..1 | Coding | Classification of patient encounter |
subject | S | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter |
Slices for participant | S | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type |
participant:attendant | S | 0..* | BackboneElement | The person responsible for delivering the child/fetus. |
type | S | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |
individual | S | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
participant:certifier | S | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. |
type | S | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
start | S | 0..1 | dateTime | Date certified |
individual | S | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from |
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) |
location | S | 0..* | BackboneElement | Information about the location of delivery |
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) |
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | SΣ | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter |
Slices for participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile(5.0.1)) | Persons involved in the encounter other than the patient |
participant:attendant | SΣ | 0..* | BackboneElement | The person responsible for delivering the child/fetus. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
participant:certifier | SΣ | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
start | SΣC | 0..1 | dateTime | Date certified |
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from |
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) Binding: AdmitSource (preferred): From where the patient was admitted. |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | Information about the location of delivery |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) |
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) |
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(5.0.1)) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:attendant.type | extensible | Pattern: LOINC Code 87286-1http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:certifier.type | extensible | Pattern: LOINC Code 87287-9http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | |
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 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) | ||||
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
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 | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
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 | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΣ | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
Slices for participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type | ||||
participant:All Slices | Content/Rules for all slices | |||||||
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 | ||||
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile(5.0.1) S | US Core PractitionerRole Profile(5.0.1) | US Core RelatedPerson Profile) | Persons involved in the encounter other than the patient | ||||
participant:attendant | SΣ | 0..* | BackboneElement | The person responsible for delivering the child/fetus. | ||||
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 | ||||
type | SΣ | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient | ||||
participant:certifier | SΣ | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. | ||||
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 | ||||
type | SΣ | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Date certified | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile(5.0.1) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
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 | ||||
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
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 | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from | ||||
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) Binding: AdmitSource (preferred): From where the patient was admitted. | ||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | ||||
location | S | 0..* | BackboneElement | Information about the location of delivery | ||||
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 | ||||
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) | ||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(5.0.1)) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:attendant.type | extensible | Pattern: LOINC Code 87286-1http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:certifier.type | extensible | Pattern: LOINC Code 87287-9http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |
identifier | S | 0..* | Identifier | Identifier(s) by which this encounter is known |
status | S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
class | S | 1..1 | Coding | Classification of patient encounter |
subject | S | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter |
Slices for participant | S | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type |
participant:attendant | S | 0..* | BackboneElement | The person responsible for delivering the child/fetus. |
type | S | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |
individual | S | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
participant:certifier | S | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. |
type | S | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |
period | 0..1 | Period | Period of time during the encounter that the participant participated | |
start | S | 0..1 | dateTime | Date certified |
individual | S | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from |
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) |
location | S | 0..* | BackboneElement | Information about the location of delivery |
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) |
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type |
subject | SΣ | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter |
Slices for participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type |
participant:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile(5.0.1)) | Persons involved in the encounter other than the patient |
participant:attendant | SΣ | 0..* | BackboneElement | The person responsible for delivering the child/fetus. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
participant:certifier | SΣ | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
start | SΣC | 0..1 | dateTime | Date certified |
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
reasonReference | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile | US Core Condition Encounter Diagnosis Profile) | Reason the encounter takes place (reference) |
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from |
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) Binding: AdmitSource (preferred): From where the patient was admitted. |
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 |
location | S | 0..* | BackboneElement | Information about the location of delivery |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) |
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) |
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(5.0.1)) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:attendant.type | extensible | Pattern: LOINC Code 87286-1http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.participant:certifier.type | extensible | Pattern: LOINC Code 87287-9http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | |
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | USCoreEncounterProfile(5.0.1) | An interaction during which services are provided to the patient | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
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 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) | ||||
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
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 | ||||
status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
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 | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
subject | SΣ | 1..1 | Reference(Patient - Mother - Vital Records) | The patient or group present at the encounter | ||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
Slices for participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type | ||||
participant:All Slices | Content/Rules for all slices | |||||||
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 | ||||
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 0..1 | Reference(US Core Practitioner Profile(5.0.1) S | US Core PractitionerRole Profile(5.0.1) | US Core RelatedPerson Profile) | Persons involved in the encounter other than the patient | ||||
participant:attendant | SΣ | 0..* | BackboneElement | The person responsible for delivering the child/fetus. | ||||
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 | ||||
type | SΣ | 1..1 | CodeableConcept | Birth attendant [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87286-1 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient | ||||
participant:certifier | SΣ | 0..* | BackboneElement | The individual who certifies to the fact that the birth occurred. | ||||
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 | ||||
type | SΣ | 1..1 | CodeableConcept | Birth certifier [Extended Identifier] Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 87287-9 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 0..1 | dateTime | Date certified | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
individual | SΣ | 1..1 | Reference(Practitioner - Vital Records) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
reasonReference | SΣ | 0..* | Reference(US Core Condition Problems and Health Concerns Profile S | US Core Condition Encounter Diagnosis Profile S | US Core Procedure Profile(5.0.1) | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
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 | ||||
condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | S | 0..1 | BackboneElement | Details about the admission to a healthcare service | ||||
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 | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | S | 0..1 | Reference(US Core Location Profile(5.0.1)) | If mother transferred, facility transferred from | ||||
admitSource | S | 0..1 | CodeableConcept | If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) Binding: AdmitSource (preferred): From where the patient was admitted. | ||||
reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: US Core Discharge Disposition (preferred): National Uniform Billing Committee, manual UB-04, UB form locator 17 | ||||
location | S | 0..* | BackboneElement | Information about the location of delivery | ||||
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 | ||||
location | S | 1..1 | Reference(US Core Location Profile(5.0.1)) | Facility name (if not institution, give street and number) | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
physicalType | S | 0..1 | CodeableConcept | The value set contains the list of values used to indicate the type of place where birth or delivery occurred. Binding: Birth or Delivery Occurred (NCHS) (preferred): Birth or Delivery Occurred (NCHS) | ||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(US Core Organization Profile(5.0.1)) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:attendant.type | extensible | Pattern: LOINC Code 87286-1http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.participant:certifier.type | extensible | Pattern: LOINC Code 87287-9http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | preferred | USCoreDischargeDisposition (a valid code from http://www.nubc.org/patient-discharge )http://hl7.org/fhir/us/core/ValueSet/us-core-discharge-disposition | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | preferred | PHVS_BirthDeliveryOccurred_NCHShttp://phinvads.cdc.gov/fhir/ValueSet/2.16.840.1.114222.4.11.7124 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 19 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron