This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
FHIR Infrastructure | Maturity Level: 1 | Informative |
Who What When Where Why - Common pattern for all resources that deals with attribution.
All resources include some attribution information. Classically, this information includes:
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:
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"
No references for this Pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FiveWs | I | Logical | Who What When Where Why - Common pattern for all resources that deals with attribution | |
identifier | 0..* | Identifier | Business Identifier | |
version | 0..1 | string | Identifier for this version | |
status | ?! | 0..1 | code | Status Field Binding: Canonical Status Codes for FHIR Resources (Required) |
class | 0..* | CodeableConcept | Classifier Field | |
grade | 0..1 | CodeableConcept | A field that indicates the potential impact of the content of the resource | |
what[x] | 0..1 | What this resource is about | ||
whatCodeableConcept | CodeableConcept | |||
whatReference | Reference(Any) | |||
subject | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization) | Who this resource is about | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Context for the work described in this resource | |
init | 0..1 | dateTime | When the work described in this resource was started (or will be) | |
planned | 0..* | Timing | When this resource is planned to occur | |
done[x] | 0..1 | When the work described in this resource was completed (or will be) | ||
doneDateTime | dateTime | |||
donePeriod | Period | |||
recorded | 0..1 | instant | When 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 | ||
whereCodeableConcept | CodeableConcept | |||
whereReference | Reference(Location) | |||
why[x] | 0..* | Why this work was done | ||
whyCodeableConcept | CodeableConcept | |||
whyReference | Reference(Any) | |||
Documentation for this format |
UML Diagram (Legend)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
FiveWs | I | Logical | Who What When Where Why - Common pattern for all resources that deals with attribution | |
identifier | 0..* | Identifier | Business Identifier | |
version | 0..1 | string | Identifier for this version | |
status | ?! | 0..1 | code | Status Field Binding: Canonical Status Codes for FHIR Resources (Required) |
class | 0..* | CodeableConcept | Classifier Field | |
grade | 0..1 | CodeableConcept | A field that indicates the potential impact of the content of the resource | |
what[x] | 0..1 | What this resource is about | ||
whatCodeableConcept | CodeableConcept | |||
whatReference | Reference(Any) | |||
subject | 0..* | Reference(Patient | Practitioner | RelatedPerson | Organization) | Who this resource is about | |
context | 0..1 | Reference(Encounter | EpisodeOfCare) | Context for the work described in this resource | |
init | 0..1 | dateTime | When the work described in this resource was started (or will be) | |
planned | 0..* | Timing | When this resource is planned to occur | |
done[x] | 0..1 | When the work described in this resource was completed (or will be) | ||
doneDateTime | dateTime | |||
donePeriod | Period | |||
recorded | 0..1 | instant | When 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 | ||
whereCodeableConcept | CodeableConcept | |||
whereReference | Reference(Location) | |||
why[x] | 0..* | Why this work was done | ||
whyCodeableConcept | CodeableConcept | |||
whyReference | Reference(Any) | |||
Documentation for this format |
Alternate definitions: Master Definition XML + JSON.
Path | ValueSet | Type | Documentation |
---|---|---|---|
FiveWs.status | CanonicalStatusCodesForFHIRResources | Required | The master set of status codes used throughout FHIR. All status codes are mapped to one of these codes. |
Todo
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 | 2 N | 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 | 2 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 | 1 N | |||||||||
Appointment | 1 | 1 | 3 N | 4 N | 1 N | 1 N | 2 N | |||||||||||||
AppointmentResponse | 1 | 1 N | 1 N | 1 N | ||||||||||||||||
ArtifactAssessment | 1 | 1 N | ||||||||||||||||||
AuditEvent | 1 N | 7 N | 1 N | 5 N | 1 N | 1 | 1 N | 1 N | 1 N | 1 N | 5 N | 6 N | 2 N | 4 N | ||||||
Basic | 1 | 1 N | 1 | 1 N | 1 | |||||||||||||||
BiologicallyDerivedProduct | 2 N | |||||||||||||||||||
BodyStructure | 1 | 1 N | 10 NC | 1 N | 1 N | |||||||||||||||
Bundle | 1 | 1 N | 1 N | |||||||||||||||||
CapabilityStatement | 2 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 | |||||||||
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 N | 2 N | 2 N | 1 N | |||||||||||
CommunicationRequest | 1 | 1 | 2 N | 1 N | 1 | 2 N | 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 | 2 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 | 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 N | 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 N | 1 | 3 N | |||||||||||
Device | 2 N | 3 N | 12 N | 2 N | 2 N | |||||||||||||||
DeviceAlert | 1 | 1 | 1 N | 1 N | 1 N | 1 | 1 N | 1 | 1 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 N | 1 | 1 N | 1 N | 1 N | 1 N | 1 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 | |||||||||||
DocumentReference | 1 | 1 | 2 N | 1 N | 2 NC | 1 | 1 C | 1 N | 1 N | 1 | 1 N | |||||||||
Encounter | 1 | 1 | 1 | 1 N | 1 NC | 1 | 1 NC | 1 N | 1 N | 1 N | 2 N | |||||||||
EncounterHistory | 1 | 1 | 1 | 1 NC | 1 | 1 N | 1 N | |||||||||||||
Endpoint | 1 | 1 | 1 N | 1 N | 1 N | |||||||||||||||
EnrollmentRequest | 2 N | |||||||||||||||||||
EnrollmentResponse | 1 N | |||||||||||||||||||
EpisodeOfCare | 1 | 1 | 1 N | 2 NC | 1 | 1 N | ||||||||||||||
EventDefinition | 2 N | 2 N | 1 | 1 N | 1 N | 1 N | 1 N | |||||||||||||
Evidence | 2 N | 1 | 1 | 1 N | 1 N | 1 N | ||||||||||||||
EvidenceReport | 2 N | 1 | 1 N | |||||||||||||||||
EvidenceVariable | 2 N | 1 | 1 | 1 N | 1 N | 1 N | ||||||||||||||
ExampleScenario | 2 N | 1 | 1 | 1 N | 1 NC | 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 | 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 | 2 N | 1 | 1 | 1 N | 1 NC | 1 N | 1 N | 1 N | ||||||||||||
Group | 2 N | 1 | 1 | 2 N | 1 N | 1 N | 1 N | 2 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 N | 1 N | 1 | 1 N | 1 N | 1 N | ||||||||||||
ImagingStudy | 1 | 1 | 1 N | 1 | 1 N | 1 N | 1 | 2 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 | 2 N | 1 | 1 | 1 N | 1 N | 1 N | 1 N | |||||||||||||
Ingredient | 1 N | |||||||||||||||||||
InsurancePlan | 1 | |||||||||||||||||||
InsuranceProduct | 1 | 1 | 1 N | |||||||||||||||||
InventoryReport | 1 | 1 | ||||||||||||||||||
Invoice | 1 | 1 | 1 N | 1 | 1 | |||||||||||||||
Library | 2 N | 2 N | 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 | 2 N | 1 | 1 N | 1 N | 1 N | 1 N | |||||||||||||
MeasureReport | 1 | 1 | 1 N | 1 N | 4 N | 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 | ||||||||
MedicationStatement | 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 | 2 N | 1 N | 1 N | ||||||||||||||||
MolecularDefinition | 1 | |||||||||||||||||||
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 N | 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 | 2 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 | ||||||||||||||
Permission | 1 | |||||||||||||||||||
Person | 1 | 1 N | ||||||||||||||||||
PersonalRelationship | 1 NC | |||||||||||||||||||
PlanDefinition | 2 N | 2 N | 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 N | 1 | 1 N | 1 N | 1 N | 1 N | 1 N | 3 N | 1 N | 4 N | |||||||
Questionnaire | 2 N | 1 | 1 | 1 N | 1 NC | 1 N | 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 | 1 N | 1 N | 1 N | |||||||||||
ResearchStudy | 1 | 1 | 1 NC | 2 N | 1 N | 1 N | 1 N | |||||||||||||
ResearchSubject | 1 | 2 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 | 2 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 | 2 N | 1 N | ||||||||||||
SpecimenDefinition | 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 | 2 N | 1 N | 3 N | 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 | |||||||||||||
TestPlan | 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 | 2 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:
Flags: