Birth And Fetal Death (BFDR) FHIR Implementation Guide
2.0.0 - STU2 - CIBuild United States of America flag

Birth And Fetal Death (BFDR) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-bfdr/ and changes regularly. See the Directory of published versions

Resource Profile: Encounter - Maternity

Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Encounter-maternity Version: 2.0.0
Standards status: Draft Computable Name: EncounterMaternity
Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.28

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.

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 125 Mother Transferred? TRAN hospitalization.admitSource = "hosp-trans" codeable HL7EncounterAdmitSourceVS,
See note on patient transfers

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 11 Place Where Delivery Occurred DPLACE location.physicalType codeable BirthDeliveryOccurredVS
Fetal Death 347 Date Signed by Certifier--Year CERTIFIED_YR participant:certifier.period.start dateTime See PartialDatesAndTimes
Fetal Death 348 Date Signed by Certifier--Month CERTIFIED_MO participant:certifier.period.start dateTime See PartialDatesAndTimes
Fetal Death 349 Date Signed by Certifier--Day CERTIFIED_DY participant:certifier.period.start dateTime See PartialDatesAndTimes

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
28 Mother Transferred for Maternal Medical or Fetal Indications for Delivery? hospitalization.admitSource (Y if present, N if not present) Certificate of Live Birth
23 Was the mother transferred to this facility for maternal medical or fetal indications for delivery? hospitalization.admitSource (Y if present, N if not present) Facility Worksheet for the Live Birth Certificate
7 Place Where Delivery Occurred location.physicalType Report of Fetal Death
7.3 Home Birth: Planned to deliver at home? location.physicalType Report of Fetal Death
5 Place of delivery location.physicalType Facility Worksheet for the Report of Fetal Death
5.3 Planned to deliver at home location.physicalType Facility Worksheet for the Report of Fetal Death

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role.url 1..1 uri "http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role"
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Binding: Value Set - Role Vital Records (extensible): Parental Role
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:attendant This element must be supported. This element is included in summaries. 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:attendant.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth attendant [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:attendant.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier This element must be supported. This element is included in summaries. 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:certifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth certifier [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:certifier.period.start This element is included in summaries. C 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement Information about the location of delivery
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.identifier This element is included in summaries. 0..1 Identifier Facility ID (state-assigned)
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:role.​value[x] Base extensible Value Set - Role Vital Records 📦2.0.0 Vital Records Common Library v2.0
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base extensible US Core Encounter Type 📦5.0.1 US Core v5.0
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:attendant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:certifier.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦5.0.1 US Core v5.0
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.subject 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.Slices for participant 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:attendant 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.type 1..1 CodeableConcept Birth attendant [Extended Identifier]
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.individual 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.type 1..1 CodeableConcept Birth certifier [Extended Identifier]
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period
Encounter.Slices for participant.participant:certifier.period.start 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.individual 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Encounter.location 0..* BackboneElement Information about the location of delivery
Encounter.location.location 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.identifier 0..1 Identifier Facility ID (state-assigned)
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for extension.extension:role.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role.url 1..1 uri "http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role"
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Binding: Value Set - Role Vital Records (extensible): Parental Role
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.id 0..1 string Unique id for inter-element referencing
Encounter.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type This element is included in summaries. 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.
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:attendant This element must be supported. This element is included in summaries. 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:attendant.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:attendant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:attendant.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth attendant [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:attendant.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier This element must be supported. This element is included in summaries. 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:certifier.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:certifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:certifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth certifier [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:certifier.period.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:certifier.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:certifier.period.start This element is included in summaries. C 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Encounter.Slices for participant.participant:certifier.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement Information about the location of delivery
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.location.location.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.location.location.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Encounter.location.location.identifier This element is included in summaries. 0..1 Identifier Facility ID (state-assigned)
Encounter.location.location.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter
Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.extension:role.​value[x] Base extensible Value Set - Role Vital Records 📦2.0.0 Vital Records Common Library v2.0
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base extensible US Core Encounter Type 📦5.0.1 US Core v5.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.5
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:attendant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:certifier.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦5.0.1 US Core v5.0
Encounter.location.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role.url 1..1 uri "http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role"
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Binding: Value Set - Role Vital Records (extensible): Parental Role
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:attendant This element must be supported. This element is included in summaries. 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:attendant.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth attendant [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:attendant.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier This element must be supported. This element is included in summaries. 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:certifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth certifier [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:certifier.period.start This element is included in summaries. C 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement Information about the location of delivery
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.identifier This element is included in summaries. 0..1 Identifier Facility ID (state-assigned)
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:role.​value[x] Base extensible Value Set - Role Vital Records 📦2.0.0 Vital Records Common Library v2.0
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base extensible US Core Encounter Type 📦5.0.1 US Core v5.0
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:attendant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:certifier.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦5.0.1 US Core v5.0
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCoreEncounterProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.subject 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.Slices for participant 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:attendant 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.type 1..1 CodeableConcept Birth attendant [Extended Identifier]
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.individual 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.type 1..1 CodeableConcept Birth certifier [Extended Identifier]
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period
Encounter.Slices for participant.participant:certifier.period.start 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.individual 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.hospitalization
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Encounter.location 0..* BackboneElement Information about the location of delivery
Encounter.location.location 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.identifier 0..1 Identifier Facility ID (state-assigned)
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* USCoreEncounterProfile An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role 1..1 (Complex) Differentiates Birth and Maternity Encounters.
URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role
Encounter.Slices for extension.extension:role.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for extension.extension:role.extension 0..0 Extension
Slice: Unordered, Open by value:url
Encounter.Slices for extension.extension:role.url 1..1 uri "http://hl7.org/fhir/us/bfdr/StructureDefinition/Extension-role"
Encounter.Slices for extension.extension:role.value[x] 1..1 CodeableConcept Value set used to indicate father or mother.
Binding: Value Set - Role Vital Records (extensible): Parental Role
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "MTH"
    }
  ]
}
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.identifier.id 0..1 string Unique id for inter-element referencing
Encounter.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Encounter.identifier.type This element is included in summaries. 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.
Encounter.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Encounter.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Encounter.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Encounter.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Encounter.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element must be supported. This element is included in summaries. 1..1 Coding Classification of patient encounter
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element must be supported. This element is included in summaries. 1..* CodeableConcept Specific type of encounter
Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient - Mother Vital Records) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.Slices for participant This element must be supported. This element is included in summaries. 0..* BackboneElement List of participants involved in the encounter
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for participant.participant:All Slices Content/Rules for all slices
Encounter.Slices for participant.participant:All Slices.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:All Slices.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:All Slices.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.Slices for participant.participant:All Slices.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:All Slices.individual This element must be supported. This element is included in summaries. 0..1 Reference(US Core Practitioner Profile This type must be supported. | US Core PractitionerRole Profile | US Core RelatedPerson Profile) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:attendant This element must be supported. This element is included in summaries. 0..* BackboneElement The person responsible for delivering the child/fetus.
Encounter.Slices for participant.participant:attendant.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:attendant.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:attendant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:attendant.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth attendant [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87286-1"
    }
  ]
}
Encounter.Slices for participant.participant:attendant.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:attendant.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Attendant) Persons involved in the encounter other than the patient
Encounter.Slices for participant.participant:certifier This element must be supported. This element is included in summaries. 0..* BackboneElement The individual who certifies to the fact that the birth occurred.
Encounter.Slices for participant.participant:certifier.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:certifier.extension 0..* Extension Additional content defined by implementations
Encounter.Slices for participant.participant:certifier.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.Slices for participant.participant:certifier.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Birth certifier [Extended Identifier]
Binding: ParticipantType (extensible): Role of participant in encounter.

Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "87287-9"
    }
  ]
}
Encounter.Slices for participant.participant:certifier.period This element must be supported. 0..1 Period Period of time during the encounter that the participant participated
Encounter.Slices for participant.participant:certifier.period.id 0..1 string Unique id for inter-element referencing
Encounter.Slices for participant.participant:certifier.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.Slices for participant.participant:certifier.period.start This element is included in summaries. C 0..1 dateTime Date certified
Encounter.Slices for participant.participant:certifier.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Encounter.Slices for participant.participant:certifier.individual This element must be supported. This element is included in summaries. 1..1 Reference(Practitioner - Birth Certifier) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period This element must be supported. 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element must be supported. This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element must be supported. This element is included in summaries. 0..* Reference(US Core Condition Problems and Health Concerns Profile This type must be supported. | US Core Condition Encounter Diagnosis Profile This type must be supported. | US Core Procedure Profile | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.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.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization This element must be supported. 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Birth and Fetal Death Location) If mother transferred, facility transferred from
Encounter.hospitalization.admitSource 0..1 CodeableConcept If mother transferred for delivery set code = "hosp-trans" (Transferred from other hospital) from codesystem http://terminology.hl7.org/CodeSystem/admit-source.
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.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.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition This element must be supported. 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
Encounter.location This element must be supported. 0..* BackboneElement Information about the location of delivery
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location This element must be supported. 1..1 Reference(Birth and Fetal Death Location) Facility name (if not institution, give street and number)
Encounter.location.location.id 0..1 string Facility ID
Encounter.location.location.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Encounter.location.location.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Encounter.location.location.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Encounter.location.location.identifier This element is included in summaries. 0..1 Identifier Facility ID (state-assigned)
Encounter.location.location.display This element is included in summaries. 0..1 string Text alternative for the resource
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 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 Delivery Occurred (preferred): Birth or Delivery Occurred (NCHS)
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 0..1 Reference(US Core Organization Profile) The organization (facility) responsible for this encounter
Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Encounter.extension:role.​value[x] Base extensible Value Set - Role Vital Records 📦2.0.0 Vital Records Common Library v2.0
Encounter.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.5
Encounter.type Base extensible US Core Encounter Type 📦5.0.1 US Core v5.0
Encounter.serviceType Base example Service type 📦4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.5
Encounter.participant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:attendant.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.participant:certifier.​type Base extensible Participant type 📦4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📦4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📦4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📦4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.5
Encounter.hospitalization.​dietPreference Base example Diet 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📦4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📦4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base preferred US Core Discharge Disposition 📦5.0.1 US Core v5.0
Encounter.location.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base preferred Birth Delivery Occurred 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron