Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

2.1.29 Pattern FiveWs - Content

FHIR Infrastructure Maturity Level: 1Informative

Who What When Where Why - Common pattern for all resources that deals with attribution.

2.1.29.1 Scope and Usage

All resources include some attribution information. Classically, this information includes:

  • Who
  • What
  • When
  • Where
  • Why

This is classically known as the 'Five Ws' - hence the name of this pattern. The pattern also includes additional information that is common across many resources.

The Five Ws logical model is NOT a resource. It is not part of the FHIR schema and cannot appear directly in FHIR instances. Instead, it defines a pattern adhered to by other resources. This pattern serves two purposes:

  • It offers guidance to work groups designing resources and helps ensure consistency of content created by different work groups
  • It provides a standard "view" that might be useful for implementers in processing and manipulating all resources that adhere to the same pattern. (Tooling that supports this may become available in a future release.)

Note that the guidance here is around the types of information that might be captured, not around element names. For example "why" would more typically be labeled as something like "reason" and "where" would be more typically labeled "location"

2.1.29.2 Boundaries and Relationships

To do

2.1.29.3 Background and Context

To do

2.1.29.4 References to this Pattern

No references for this Pattern.

2.1.29.5 Pattern Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. FiveWs ILogicalWho What When Where Why - Common pattern for all resources that deals with attribution
... identifier 0..*IdentifierBusiness Identifier

... version 0..1stringIdentifier for this version
... status ?!0..1codeStatus Field
Canonical Status Codes for FHIR Resources (Required)
... grade 0..1CodeableConceptA field that indicates the potential impact of the content of the resource
... what[x] 0..1What this resource is about
.... whatCodeableConceptCodeableConcept
.... whatReferenceReference(Any)
... subject 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who this resource is about

... context 0..1Reference(Encounter | EpisodeOfCare)Context for the work described in this resource
... init 0..1dateTimeWhen the work described in this resource was started (or will be)
... planned 0..*TimingWhen this resource is planned to occur

... done[x] 0..1When the work described in this resource was completed (or will be)
.... doneDateTimedateTime
.... donePeriodPeriod
... recorded 0..1instantWhen this resource itself was created
... author 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who authored the content of the resource

... source 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who provided the information in this resource

... actor 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who did the work described the resource (or will do)

... cause 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who prompted the work described in the resource

... witness 0..*Reference(Patient | Practitioner | RelatedPerson)Who attests to the content of the resource (individual or org)

... who 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)An actor involved in the work described by this resource

... where[x] 0..*The location of the work described

.... whereCodeableConceptCodeableConcept
.... whereReferenceReference(Location)
... why[x] 0..*Why this work was done

.... whyCodeableConceptCodeableConcept
.... whyReferenceReference(Any)

doco Documentation for this format

UML Diagram (Legend)

FiveWs (Base) «Pattern»Business Identifieridentifier : Identifier [0..*]Identifier for this versionversion : string [0..1]Status Field (this element modifies the meaning of other elements)status : code [0..1] « Status Field. (Strength=Required)CanonicalStatusCodesForFHIRRe...! »Classifier Fieldclass : CodeableConcept [0..*]A field that indicates the potential impact of the content of the resourcegrade : CodeableConcept [0..1]what this resource is aboutwhat[x] : DataType [0..1] « CodeableConcept|Reference(Any) »Who this resource is aboutsubject : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »a resource that gives context for the work described in this resource (usually Encounter or EpisodeOfCare)context : Reference [0..1] « Encounter|EpisodeOfCare »when the work described in this resource was started (or will be)init : dateTime [0..1]when this resource is planned to occurplanned : Timing [0..*]when the work described in this resource was completed (or will be)done[x] : DataType [0..1] « dateTime|Period »when this resource itself was createdrecorded : instant [0..1]who authored the content of the resourceauthor : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »Who provided the information in this resourcesource : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who did the work described the resource (or will do)actor : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who prompted the work described in the resourcecause : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who attests to the content of the resource (individual or org)witness : Reference [0..*] « Patient|Practitioner|RelatedPerson »An actor involved in the work described by this resourcewho : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »The location of the work describedwhere[x] : DataType [0..*] « CodeableConcept|Reference(Location) »Why this work was donewhy[x] : DataType [0..*] « CodeableConcept|Reference(Any) »

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. FiveWs ILogicalWho What When Where Why - Common pattern for all resources that deals with attribution
... identifier 0..*IdentifierBusiness Identifier

... version 0..1stringIdentifier for this version
... status ?!0..1codeStatus Field
Canonical Status Codes for FHIR Resources (Required)
... grade 0..1CodeableConceptA field that indicates the potential impact of the content of the resource
... what[x] 0..1What this resource is about
.... whatCodeableConceptCodeableConcept
.... whatReferenceReference(Any)
... subject 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who this resource is about

... context 0..1Reference(Encounter | EpisodeOfCare)Context for the work described in this resource
... init 0..1dateTimeWhen the work described in this resource was started (or will be)
... planned 0..*TimingWhen this resource is planned to occur

... done[x] 0..1When the work described in this resource was completed (or will be)
.... doneDateTimedateTime
.... donePeriodPeriod
... recorded 0..1instantWhen this resource itself was created
... author 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who authored the content of the resource

... source 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who provided the information in this resource

... actor 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who did the work described the resource (or will do)

... cause 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Who prompted the work described in the resource

... witness 0..*Reference(Patient | Practitioner | RelatedPerson)Who attests to the content of the resource (individual or org)

... who 0..*Reference(Patient | Practitioner | RelatedPerson | Organization)An actor involved in the work described by this resource

... where[x] 0..*The location of the work described

.... whereCodeableConceptCodeableConcept
.... whereReferenceReference(Location)
... why[x] 0..*Why this work was done

.... whyCodeableConceptCodeableConcept
.... whyReferenceReference(Any)

doco Documentation for this format

UML Diagram (Legend)

FiveWs (Base) «Pattern»Business Identifieridentifier : Identifier [0..*]Identifier for this versionversion : string [0..1]Status Field (this element modifies the meaning of other elements)status : code [0..1] « Status Field. (Strength=Required)CanonicalStatusCodesForFHIRRe...! »Classifier Fieldclass : CodeableConcept [0..*]A field that indicates the potential impact of the content of the resourcegrade : CodeableConcept [0..1]what this resource is aboutwhat[x] : DataType [0..1] « CodeableConcept|Reference(Any) »Who this resource is aboutsubject : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »a resource that gives context for the work described in this resource (usually Encounter or EpisodeOfCare)context : Reference [0..1] « Encounter|EpisodeOfCare »when the work described in this resource was started (or will be)init : dateTime [0..1]when this resource is planned to occurplanned : Timing [0..*]when the work described in this resource was completed (or will be)done[x] : DataType [0..1] « dateTime|Period »when this resource itself was createdrecorded : instant [0..1]who authored the content of the resourceauthor : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »Who provided the information in this resourcesource : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who did the work described the resource (or will do)actor : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who prompted the work described in the resourcecause : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »who attests to the content of the resource (individual or org)witness : Reference [0..*] « Patient|Practitioner|RelatedPerson »An actor involved in the work described by this resourcewho : Reference [0..*] « Patient|Practitioner|RelatedPerson| Organization »The location of the work describedwhere[x] : DataType [0..*] « CodeableConcept|Reference(Location) »Why this work was donewhy[x] : DataType [0..*] « CodeableConcept|Reference(Any) »

 

Alternate definitions: Master Definition XML + JSON.

2.1.29.5.1 Terminology Bindings

PathDefinitionTypeReference
FiveWs.status

The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes.

RequiredCanonicalStatusCodesForFHIRResources

Todo

2.1.29.5.2 Mappings

identifier version status class grade what[x] subject context init planned done[x] recorded author source actor cause witness who where[x] why[x]
Account 1 1 1 N 1 N 1 1 N
ActivityDefinition 2 N 1 1 1 N 1 N 1 N 1 N
ActorDefinition 2 N 1 1 1 N 1 N 1 N 1 N
AdministrableProductDefinition 1 N
AdverseEvent 1 2 N 1 N 1 1 N 1 N 1 N 1 N 1
AllergyIntolerance 1 2 N 2 N 1 N 1 N 1 N 1 N 1 N 1 N 1 N
Appointment 1 1 3 N 4 NC 1 N 1 N 2 N
AppointmentResponse 1 1 N 1 N 1 N
ArtifactAssessment 1 1 N
AuditEvent 8 NC 1 N 6 NC 1 N 1 4 N 5 N 2 N 5 N
Basic 1 1 N 1 1 N 1
BiologicallyDerivedProduct 2 N
BodyStructure 1 1 N 9 NC 1 N
Bundle 1 1 N 1 N
CapabilityStatement 1 N 1 1 1 N 1 N 1 N 1 N
CarePlan 1 1 1 N 1 N 1 1 N 1 N 1 N 1 N 1 N 1 N 1 N
CareTeam 1 1 1 N 1 1 N 1 N 1 N
ChargeItem 1 1 1 N 1 1 N 1 N 2 N 2 N
ChargeItemDefinition 2 N 1 1 1 N 1 N 1 N 1 N
Citation 2 N 1 1 N 1 N 1 N 1 N
Claim 2 1 3 N 1 N 2 N 1 N 1 N 1 N 1 N 1 N 2 N
ClaimResponse 1 1 3 N 1 N 1 N 1 N 2 N 1 N 1 N
ClinicalImpression 1 1 1 1 N 1 N 1 N 1 N 1 N
ClinicalUseDefinition 1 N
CodeSystem 2 N 1 1 1 N 1 N 1 N 1 N
Communication 1 1 1 N 1 N 1 3 NC 2 N 2 N 1 N
CommunicationRequest 1 1 2 N 1 N 1 2 NC 1 N 1 N 1 N 2 N 1 N
CompartmentDefinition 1 N 1 1 1 N 1 N 1 N 1 N
Composition 2 N 1 1 3 N 1 1 N 1 N 2 1 N
ConceptMap 2 N 1 1 1 N 1 N 1 N 1 N
Condition 1 2 N 1 N 1 N 1 N 1 1 N 1 N 1 N 1 N 1 N
ConditionDefinition 2 N 1 1 1 N 1 N 1 N
Consent 1 1 1 N 1 1 N 1 N
Contract 1 21 NC 2 N 1 N 2 N 1 N 1 N
Coverage 1 1 1 N 4 N 1 N
CoverageEligibilityRequest 1 1 2 N 1 N 1 N 1 N 1 N 2 N 1 N 1 N
CoverageEligibilityResponse 1 1 1 N 1 N 1 N 1 N 2 N 1 N
DetectedIssue 1 1 2 N 1 N 1 1 N 1 3 N
Device 2 N 2 N 12 N 2 N 3 N
DeviceDefinition 1 5 N 2 N
DeviceDispense 1 1 1 N 1 1 NC
DeviceMetric 1 2 N
DeviceRequest 1 1 1 N 1 N 4 NC 1 1 N 1 N 1 N 1 N 2 N 1 N
DeviceUsage 1 1 1 N 1 N 1 N 2 N 1 N
DiagnosticReport 1 1 1 N 1 N 1 1 N 1 N 1 N 2 N
DocumentManifest 2 N 1 1 N 1 1 N 1 1 N
DocumentReference 1 2 N 2 NC 1 1 C 1 N 1 N
Encounter 1 1 1 1 N 1 NC 1 1 NC 1 N 1 N 1 N 2 N
Endpoint 1 1 1 N 1 N 1 N
EnrollmentRequest 2 N
EnrollmentResponse 1 N
EpisodeOfCare 1 1 1 N 1 N 1 N 1 N
EventDefinition 2 N 1 1 1 N 1 N 1 N 1 N
Evidence 2 N 1 1 1 N 1 N
EvidenceReport 2 N 1 1 N
EvidenceVariable 2 N 1 1 1 N 1 N
ExampleScenario 2 N 1 1 1 N 1 N 1 N 1 N
ExplanationOfBenefit 1 1 3 N 1 N 3 N 1 N 2 N 2 N 1 N 1 N 3 N 1 N
FamilyMemberHistory 1 1 1 N 1 N 1 N
Flag 1 1 1 N 1 N 1 2 N 1
FormularyItem 1
GenomicStudy 1
Goal 1 1 N 1 N 1 N 1 N 1 1 N 1 N 1 N 1 1 N
GraphDefinition 1 N 1 1 1 N 1 N 1 N 1 N
Group 1 1 N 1 N 1 N
GuidanceResponse 1 1 1 1 N 1 N 1 N 1 N
HealthcareService 1 1 N 1 N 1 N
ImagingSelection 1 1 1 1 N 1 N 1 N
ImagingStudy 1 1 1 N 1 1 N 1 N 1 2 N 1 N 1 N 1 N
Immunization 1 1 2 N 1 N 2 NC 1 N 2 N 1 1 N
ImmunizationEvaluation 1 1 1 N 1 N
ImmunizationRecommendation 1 1 N
ImplementationGuide 1 N 1 1 1 N 1 N 1 N
Ingredient 1 N
InsurancePlan 2 1 1 N
InventoryReport 1 1
Invoice 1 1 1 N 1 1
Library 2 N 1 1 1 N 1 N 1 N 1 N 1 N
Linkage 1 N 1
List 1 1 1 N 1 N 1 1 N 1 N 1 N
Location 1 2 N 3 N
ManufacturedItemDefinition 2 N
Measure 2 N 1 1 1 N 1 N 1 N 1 N
MeasureReport 1 1 1 N 1 N 1 1 N 1 N
Medication 1 1 N
MedicationAdministration 1 1 1 N 1 2 NC 1 N 1 1 N
MedicationDispense 1 1 1 N 1 1 NC
MedicationKnowledge 1 N 1 N
MedicationRequest 1 1 2 N 1 N 1 N 1 2 NC 1 N 1 N 1 N 2 N 1 N
MedicationUsage 1 1 1 N 1 N 1 1 N 1 N 1 N 1 N
MedicinalProductDefinition 1 N
MessageDefinition 2 N 1 1 1 N 1 N 1 N 1 N
MessageHeader 1 N 3 N 2 N 1 N 1 N 1 N
MolecularSequence 1
NamingSystem 3 N 1 1 2 N 1 N 2 N 1 N
NutritionIntake 1 1 1 N 1 N 1 1 N 1 1 N 1 N
NutritionOrder 1 1 1 N 1 N 5 NC 1 1 N 1 N 1 N
NutritionProduct 1 N 1 1 N
Observation 1 1 1 N 2 N 2 N 1 N 1 N 1 N 1 N
ObservationDefinition 1 N 1 N
OperationDefinition 1 N 1 1 2 N 1 N 1 N 1 N
Organization 1 1 N 1 N
OrganizationAffiliation 1 1 N 1 N 1 N
PackagedProductDefinition 1 N
Patient 1 1 N
PaymentNotice 1 1 2 N 1 N 1 N
PaymentReconciliation 1 1 1 N 1 N 1 N 1 N
Person 1 1 N
PlanDefinition 2 N 1 1 1 N 1 N 1 N 1 N
Practitioner 1 1 N
PractitionerRole 1 1 N 1 N 1 N
Procedure 1 1 1 N 1 N 2 N 1 N 1 N 1 1 N 1 N 1 1 N 1 N
Provenance 1 NC 1 N 1 N 1 1 N 1 N 1 N 4 N
Questionnaire 2 N 1 1 1 N 1 N 1 N 1 N
QuestionnaireResponse 1 1 1 1 N 1 N 1 1
RegulatedAuthorization 1 N
RelatedPerson 1 1 N 1 N 1 N
RequestOrchestration 1 1 1 N 1 N 1 N 1 1 N 1 N 1 1 N 3 N
Requirements 2 N 1 1 1 N 1 N 1 N 1 N
ResearchStudy 1 1 2 NC 2 N 1 N 1 N 1 N
ResearchSubject 1 3 N
RiskAssessment 1 1 1 N 1 N 1 1 N 1 N 1 N 1 N
Schedule 1 1 N 3 N 1 N 1 N
SearchParameter 1 N 1 1 1 N 1 N 1 N 1 N
ServiceRequest 1 1 2 N 1 N 1 N 2 N 1 N 1 N 1 N 1 N 3 N 1 N
Slot 1 4 N 2 N
Specimen 2 N 1 2 N 1 2 N 1 N 1 N 1 N 1 N
StructureDefinition 2 N 1 1 1 N 1 N 1 N 1 N
StructureMap 2 N 1 1 1 N 1 N 1 N 1 N
Subscription 1 1 1 N 1 N 1 N 1 N 1 N
SubscriptionStatus 1 1 N 1 N
SubscriptionTopic 2 N 1 1 1 N 1 N 1 N 1 N
Substance 1 1 1 N 1 N
SupplyDelivery 1 N
SupplyRequest 1 1 1 N 1 N 3 NC 1 N 1 N 1 N 1 N 1 N
Task 1 1 1 N 1 N 3 N 1 N 1 N 1 N 1 N 1 N 2 N 1 N 1 N
TerminologyCapabilities 2 N 1 1 1 N 1 N 1 N 1 N
TestReport 1 1 1 N
TestScript 2 N 1 1 1 N 1 N 1 N 1 N
Transport 1 N 1 N 2 N 1 N 1 N 1 N 1 N 1 N 2 N 3 N 3 N
ValueSet 2 N 1 1 1 N 1 N 1 N 1 N 1 N
VerificationResult 1
VisionPrescription 1 1 1 N 1 N 1 N 1 N

Each non-grey cell contains a number, the number of elements and extensions (if > 0) mapped in the resource that are mapped to the pattern element in the column. If there are 0 elements and extensions, the number is not shown. In addition, the cell has a color and some character flags.

Colors:

  • Grey: the resource has no element or extension for the pattern element
  • White: the resource has an element that implements the pattern element with the same name
  • Yellow: the resource has a documented extension that implements the pattern element with the same name
  • Blue: the resource has an element that implements the pattern element with a different name
  • Red: the resource has an element that implements that pattern element, but the type or cardinality does not match

Flags:

  • E: pattern element implemented by an extension
  • N: pattern element implemented by an element with a different name
  • T: pattern element implemented by an element with a different type
  • C: pattern element implemented by an element with a different cardinality