WHO SMART Guideline: Surveillance and Outbreak Toolkit
0.2.1 - CI Build International flag

WHO SMART Guideline: Surveillance and Outbreak Toolkit, published by WHO. This is not an authorized publication; it is the continuous build for version 0.2.1. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ot and changes regularly. See the Directory of published versions

Logical Model: SOTT1NotificationInterview - Detailed Descriptions

Draft as of 2023-11-07

Definitions for the SOTT1NotificationInterview logical model.

Guidance on how to interpret the contents of this table can be found here

0. SOTT1NotificationInterview
ShortSurveillance & Outbreak Toolkit T1 - Notification Interview
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SOTT1NotificationInterview.date
Definition

Date the case was interviewed.

ShortDate* of the day: _____/____/______
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. SOTT1NotificationInterview.organization
Definition

Unit/Department/Organization that interviewer is representing. Note, label should be adapted to suite local context.

ShortOrganization/institution*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SOTT1NotificationInterview.country
Definition

Administrative level 0: Country/territory/national boundary within which the case currently/usually resides.If transborders or international spread of outbreak

ShortCountry*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SOTT1NotificationInterview.interviewerName
Definition

Name of person conducting the interview and completing this form.

ShortInterviewer name:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTT1NotificationInterview.interviewerTitle
Definition

Profession title or function of the person conducting the interview and completing this form.

ShortInterviewer function/title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTT1NotificationInterview.caseId
Definition

Unique case identification number.

ShortCase ID*:
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1NotificationInterview.dateReported
Definition

The date when the Health Authorities were notified

ShortDate case first reported*:_____/______/________
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1NotificationInterview.reportedBy
Definition

The person or team or institution that reported this case (sick person).

ShortCase reported by:
Control0..1
BindingThe codes SHALL be taken from Reported By
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1NotificationInterview.reportingFacility
Definition

The name of the institution that reported this case

ShortName of reporting facility*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1NotificationInterview.relationshipForCase
Definition

If the person interviewed is not the case (not the sick person), provide relationship to the case (friend, bother, mother, etc.)

ShortIf not the case, relation of person interviewed to the case:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SOTT1NotificationInterview
Definition

Base definition for all elements that are defined inside a resource - but not those in a data type.

ShortSurveillance & Outbreak Toolkit T1 - Notification InterviewBase for elements defined inside a resource
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SOTT1NotificationInterview.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. SOTT1NotificationInterview.date
Definition

Date the case was interviewed.

ShortDate* of the day: _____/____/______
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SOTT1NotificationInterview.organization
Definition

Unit/Department/Organization that interviewer is representing. Note, label should be adapted to suite local context.

ShortOrganization/institution*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SOTT1NotificationInterview.country
Definition

Administrative level 0: Country/territory/national boundary within which the case currently/usually resides.If transborders or international spread of outbreak

ShortCountry*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTT1NotificationInterview.interviewerName
Definition

Name of person conducting the interview and completing this form.

ShortInterviewer name:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTT1NotificationInterview.interviewerTitle
Definition

Profession title or function of the person conducting the interview and completing this form.

ShortInterviewer function/title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1NotificationInterview.caseId
Definition

Unique case identification number.

ShortCase ID*:
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1NotificationInterview.dateReported
Definition

The date when the Health Authorities were notified

ShortDate case first reported*:_____/______/________
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1NotificationInterview.reportedBy
Definition

The person or team or institution that reported this case (sick person).

ShortCase reported by:
Control0..1
BindingThe codes SHALL be taken from Reported By
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1NotificationInterview.reportingFacility
Definition

The name of the institution that reported this case

ShortName of reporting facility*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTT1NotificationInterview.relationshipForCase
Definition

If the person interviewed is not the case (not the sick person), provide relationship to the case (friend, bother, mother, etc.)

ShortIf not the case, relation of person interviewed to the case:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SOTT1NotificationInterview
Definition

Base definition for all elements that are defined inside a resource - but not those in a data type.

ShortSurveillance & Outbreak Toolkit T1 - Notification Interview
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SOTT1NotificationInterview.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. SOTT1NotificationInterview.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SOTT1NotificationInterview.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
6. SOTT1NotificationInterview.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. SOTT1NotificationInterview.date
Definition

Date the case was interviewed.

ShortDate* of the day: _____/____/______
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTT1NotificationInterview.organization
Definition

Unit/Department/Organization that interviewer is representing. Note, label should be adapted to suite local context.

ShortOrganization/institution*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTT1NotificationInterview.country
Definition

Administrative level 0: Country/territory/national boundary within which the case currently/usually resides.If transborders or international spread of outbreak

ShortCountry*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1NotificationInterview.interviewerName
Definition

Name of person conducting the interview and completing this form.

ShortInterviewer name:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1NotificationInterview.interviewerTitle
Definition

Profession title or function of the person conducting the interview and completing this form.

ShortInterviewer function/title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1NotificationInterview.caseId
Definition

Unique case identification number.

ShortCase ID*:
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1NotificationInterview.dateReported
Definition

The date when the Health Authorities were notified

ShortDate case first reported*:_____/______/________
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTT1NotificationInterview.reportedBy
Definition

The person or team or institution that reported this case (sick person).

ShortCase reported by:
Control0..1
BindingThe codes SHALL be taken from Reported By
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTT1NotificationInterview.reportingFacility
Definition

The name of the institution that reported this case

ShortName of reporting facility*:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SOTT1NotificationInterview.relationshipForCase
Definition

If the person interviewed is not the case (not the sick person), provide relationship to the case (friend, bother, mother, etc.)

ShortIf not the case, relation of person interviewed to the case:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension