Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

8.1.18 8.11.16 Resource Patient Encounter - R3/R4 Conversions Search Parameters

Patient Administration icon Work Group Maturity Level : N/A Standards Status : Informative Security Category : Patient Compartments : Encounter , Patient , Practitioner , RelatedPerson

R3 : R4 Conversion maps Search Parameter Registry for Patient. the encounter resource

8.11.17 Search Parameters

Functional status Search parameter list for this map: 16 tests that all execute ok. All tests pass round-trip testing resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and all r3 resources are valid. ( see documentation) services.

http://hl7.org/fhir/SearchParameter/Encounter-account

8.11.18 account

Parameter account : reference

The set of accounts that may be used for billing for this Encounter

Resource Encounter
Expression Encounter.account
Target Resources Account
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-appointment

8.1.18.1 8.11.19 R3 appointment

Parameter appointment : reference

The appointment that scheduled this encounter

Resource Encounter
Expression Encounter.appointment
Target Resources Appointment
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-based-on

8.11.20 based-on

Parameter based-on : reference

The ServiceRequest that initiated this encounter

Resource Encounter
Expression Encounter.basedOn
Target Resources CarePlan , MedicationRequest , DeviceRequest , ServiceRequest
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-careteam

8.11.21 careteam

Parameter careteam : reference

Careteam allocated to R4 participate in the encounter

Resource Encounter
Expression Encounter.careTeam
Target Resources CareTeam
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-class

8.11.22 class map "http://hl7.org/fhir/StructureMap/Patient3to4" = "R3 to R4 Conversions for Patient" uses "http://hl7.org/fhir/3.0/StructureDefinition/Patient" alias PatientR3 as source uses "http://hl7.org/fhir/StructureDefinition/Patient" alias Patient as target imports "http://hl7.org/fhir/StructureMap/*3to4" group Patient(source src : PatientR3, target tgt : Patient) extends DomainResource <<type+>> { src.identifier -> tgt.identifier; src.active -> tgt.active; src.name -> tgt.name; src.telecom -> tgt.telecom; src.gender -> tgt.gender; src.birthDate -> tgt.birthDate; src.deceased : boolean as vs -> tgt.deceased = create('boolean') as vt then boolean(vs, vt); src.deceased : dateTime as vs -> tgt.deceased = create('dateTime') as vt then dateTime(vs, vt); src.address -> tgt.address; src.maritalStatus -> tgt.maritalStatus; src.multipleBirth : boolean as vs -> tgt.multipleBirth = create('boolean') as vt then boolean(vs, vt); src.multipleBirth : integer as vs -> tgt.multipleBirth = create('integer') as vt then integer(vs, vt); src.photo -> tgt.photo; src.contact as vs0 -> tgt.contact as vt0 then contact(vs0, vt0); src.animal as vs0 -> tgt.extension as vt0 then animal(vs0, vt0); src.communication as vs0 -> tgt.communication as vt0 then communication(vs0, vt0); src.generalPractitioner -> tgt.generalPractitioner; src.managingOrganization -> tgt.managingOrganization; src.link as vs0 -> tgt.link as vt0 then link(vs0, vt0); } group contact(source src, target tgt) extends BackboneElement { src.relationship -> tgt.relationship; src.name -> tgt.name; src.telecom -> tgt.telecom; src.address -> tgt.address; src.gender -> tgt.gender; src.organization -> tgt.organization; src.period -> tgt.period; } group animal(source src, target tgt) extends Element { src -> tgt.url = 'http://hl7.org/fhir/StructureDefinition/patient-animal' "animal"; src.species as vs -> tgt.extension as ext, ext.url = 'species', ext.value = vs; src.breed as vs -> tgt.extension as ext, ext.url = 'breed', ext.value = vs; src.genderStatus as vs -> tgt.extension as ext, ext.url = 'genderStatus', ext.value = vs; } group communication(source src, target tgt) extends BackboneElement { src.language -> tgt.language; src.preferred -> tgt.preferred; } group link(source src, target tgt) extends BackboneElement { src.other -> tgt.other; src.type -> tgt.type; }

Parameter class : token

Classification of patient encounter

Resource Encounter
Expression Encounter.class
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-date

8.1.18.2 8.11.23 R4 date

Parameter date : date

A date within the actualPeriod the Encounter lasted

Resources
Expression Encounter.actualPeriod
Usage Normal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-date-start

8.11.24 date-start

Parameter date-start : date

The actual start date of the Encounter

Resource Encounter
Expression Encounter.actualPeriod.start
Multiples The parameter cannot repeat or have multiple values
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-diagnosis

8.11.25 diagnosis

Parameter diagnosis : reference

The diagnosis or procedure relevant to R3 the encounter

Resource Encounter
Expression Encounter.diagnosis.condition
Target Resources Condition , Procedure
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-end-date

8.11.26 end-date map "http://hl7.org/fhir/StructureMap/Patient4to3" = "R4 to R3 Conversion for Patient" uses "http://hl7.org/fhir/StructureDefinition/Patient" alias Patient as source uses "http://hl7.org/fhir/3.0/StructureDefinition/Patient" alias PatientR3 as target imports "http://hl7.org/fhir/StructureMap/*4to3" group Patient(source src : Patient, target tgt : PatientR3) extends DomainResource <<type+>> { src.identifier -> tgt.identifier; src.active -> tgt.active; src.name -> tgt.name; src.telecom -> tgt.telecom; src.gender -> tgt.gender; src.birthDate -> tgt.birthDate; src.deceased : boolean as vs -> tgt.deceased = create('boolean') as vt then boolean(vs, vt); src.deceased : dateTime as vs -> tgt.deceased = create('dateTime') as vt then dateTime(vs, vt); src.address -> tgt.address; src.maritalStatus -> tgt.maritalStatus; src.multipleBirth : boolean as vs -> tgt.multipleBirth = create('boolean') as vt then boolean(vs, vt); src.multipleBirth : integer as vs -> tgt.multipleBirth = create('integer') as vt then integer(vs, vt); src.photo -> tgt.photo; src.contact as vs0 -> tgt.contact as vt0 then contact(vs0, vt0); src.extension as vs0 where url = 'http://hl7.org/fhir/StructureDefinition/patient-animal' -> tgt.animal as vt0 then animal(vs0, vt0) "animal"; src.communication as vs0 -> tgt.communication as vt0 then communication(vs0, vt0); src.generalPractitioner -> tgt.generalPractitioner; src.managingOrganization -> tgt.managingOrganization; src.link as vs0 -> tgt.link as vt0 then link(vs0, vt0); } group contact(source src, target tgt) extends BackboneElement { src.relationship -> tgt.relationship; src.name -> tgt.name; src.telecom -> tgt.telecom; src.address -> tgt.address; src.gender -> tgt.gender; src.organization -> tgt.organization; src.period -> tgt.period; } group animal(source src, target tgt) { src.extension as ext where url = 'species' then { ext.value as vs0 -> tgt.species = vs0 "species2"; } "species"; src.extension as ext where url = 'breed' then { ext.value as vs0 -> tgt.breed = vs0 "breed"; } "breed"; src.extension as ext where url = 'genderStatus' then { ext.value as vs0 -> tgt.genderStatus = vs0 "genderStatus"; } "genderStatus"; } group communication(source src, target tgt) extends BackboneElement { src.language -> tgt.language; src.preferred -> tgt.preferred; } group link(source src, target tgt) extends BackboneElement { src.other -> tgt.other; src.type -> tgt.type; }

Parameter end-date : date

The actual end date of the Encounter

Resource Encounter
Expression Encounter.actualPeriod.end
Multiples The parameter cannot repeat or have multiple values
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-episode-of-care

8.1.18.3 8.11.27 R4 Validation Errors episode-of-care <p>No validation errors - all conversions are clean</p>

Parameter episode-of-care : reference

Episode(s) of care that this encounter should be recorded against

Resource Encounter
Expression Encounter.episodeOfCare
Target Resources EpisodeOfCare
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-identifier

8.11.28 identifier

Parameter identifier : token

Identifier(s) by which this encounter is known

Resources
Expression Encounter.identifier
Usage Normal
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-length

8.11.29 length

Parameter length : quantity

Length of encounter in days

Resource Encounter
Expression Encounter.length
Multiples The parameter cannot repeat or have multiple values
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-location

8.11.30 location

Parameter location : reference

Location the encounter takes place

Resource Encounter
Expression Encounter.location.location
Target Resources Location
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-location-period

8.11.31 location-period

Parameter location-period : date

Time period during which the patient was present at the location

Resource Encounter
Expression Encounter.location.period
Multiples The parameter cannot repeat or have multiple values
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/Encounter-part-of

8.11.32 part-of

Parameter part-of : reference

Another Encounter this encounter is part of

Resource Encounter
Expression Encounter.partOf
Target Resources Encounter
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-participant

8.11.33 participant

Parameter participant : reference

Persons involved in the encounter other than the patient

Resource Encounter
Expression Encounter.participant.actor
Target Resources Practitioner , Group , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-participant-type

8.11.34 participant-type

Parameter participant-type : token

Role of participant in encounter

Resource Encounter
Expression Encounter.participant.type
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-patient

8.11.35 patient

Parameter patient : reference

The patient present at the encounter

Resources
Expression Encounter.subject.where(resolve() is Patient)
Usage Normal
Target Resources Patient
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-practitioner

8.11.36 practitioner

Parameter practitioner : reference

Persons involved in the encounter other than the patient

Resource Encounter
Expression Encounter.participant.actor.where(resolve() is Practitioner)
Target Resources Practitioner
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-reason-code

8.11.37 reason-code

Parameter reason-code : token

Reference to a concept (by class)

Resource Encounter
Expression Encounter.reason.concept
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-reason-reference

8.11.38 reason-reference

Parameter reason-reference : reference

Reference to a resource (by instance)

Resource Encounter
Expression Encounter.reason.reference
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-service-provider

8.11.39 service-provider

Parameter service-provider : reference

The organization (facility) responsible for this encounter

Resource Encounter
Expression Encounter.serviceProvider
Target Resources Organization
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-special-arrangement

8.11.40 special-arrangement

Parameter special-arrangement : token

Wheelchair, translator, stretcher, etc.

Resource Encounter
Expression Encounter.admission.specialArrangement
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-status

8.11.41 status

Parameter status : token

planned | in-progress | onhold | completed | cancelled | entered-in-error | unknown

Resource Encounter
Expression Encounter.status
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-subject

8.11.42 subject

Parameter subject : reference

The patient or group present at the encounter

Resource Encounter
Expression Encounter.subject
Target Resources Group , Patient
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/SearchParameter/Encounter-subject-status

8.11.43 subject-status

Parameter subject-status : token

The current status of the subject in relation to the Encounter

Resource Encounter
Expression Encounter.subjectStatus
Multiples The parameter cannot repeat or have multiple values
 
http://hl7.org/fhir/build/SearchParameter/Encounter-type

8.11.44 type

Parameter type : token

Specific type of encounter

Resources
Expression Encounter.type
Usage Normal
Multiples The parameter cannot repeat or have multiple values