Extensions for Using Data Elements from FHIR R4 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Flag_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Flag resource profile.

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

0. Flag
Definition

Prospective warnings of potential issues when providing care to the patient.

ShortKey information to flag to healthcare providers
Control0..*
Alternate NamesBarriers to Care, Alert, Warning
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Flag.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Flag.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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
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 No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. Flag.status
Definition

Supports basic workflow.

Shortactive | inactive | entered-in-error
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from FlagStatushttp://hl7.org/fhir/ValueSet/flag-status|3.0.2
(required to http://hl7.org/fhir/ValueSet/flag-status|3.0.2)

Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. Flag.code
Definition

The coded value or textual component of the flag to display to the user.

ShortCoded or textual message to display to user
Comments

If non coded, use CodeableConcept.text. This element should always be included in the narrative.

Control1..1
BindingFor example codes, see Flag Codehttp://hl7.org/fhir/ValueSet/flag-code|1.0.0
(example to http://hl7.org/fhir/ValueSet/flag-code|1.0.0)

Detail codes identifying specific flagged issues.

TypeCodeableConcept
Summarytrue
10. Flag.subject
Definition

The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.

ShortWho/What is flag about?
Control1..1
TypeReference(Patient, Location, Group, Organization, Practitioner, PlanDefinition, Medication, Procedure)
Summarytrue

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

0. Flag
2. Flag.author
4. Flag.author.extension
Control0..*
SlicingThis element introduces a set of slices on Flag.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Flag.author.extension:author
    Slice Nameauthor
    Definition

    R4: Flag.author

    ShortR4: author
    Comments

    Element Flag.author is mapped to FHIR STU3 element Flag.author as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Flag.author with unmapped reference targets: PractitionerRole.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

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

    0. Flag
    Definition

    Prospective warnings of potential issues when providing care to the patient.

    ShortKey information to flag to healthcare providers
    Control0..*
    Alternate NamesBarriers to Care, Alert, Warning
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
    2. Flag.id
    Definition

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

    ShortLogical id of this artifact
    Comments

    The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

    Control0..1
    Typeid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    4. Flag.meta
    Definition

    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

    ShortMetadata about the resource
    Control0..1
    TypeMeta
    Summarytrue
    6. Flag.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

    This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

    Control0..1
    Typeuri
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    8. Flag.language
    Definition

    The base language in which the resource is written.

    ShortLanguage of the resource content
    Comments

    Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from Common Languages
    (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

    A human language.

    Additional BindingsPurpose
    All LanguagesMax Binding
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. Flag.text
    Definition

    A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

    ShortText summary of the resource, for human interpretation
    Comments

    Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

    Control0..1
    This element is affected by the following invariants: dom-1
    TypeNarrative
    Alternate Namesnarrative, html, xhtml, display
    12. Flag.contained
    Definition

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

    ShortContained, inline Resources
    Comments

    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

    Control0..*
    TypeResource
    Alternate Namesinline resources, anonymous resources, contained resources
    14. Flag.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to 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
    Alternate Namesextensions, user content
    16. Flag.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to 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
    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 No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    18. Flag.identifier
    Definition

    Identifier assigned to the flag for external use (outside the FHIR environment).

    ShortBusiness identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Summarytrue
    20. Flag.status
    Definition

    Supports basic workflow.

    Shortactive | inactive | entered-in-error
    Comments

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from FlagStatus
    (required to http://hl7.org/fhir/ValueSet/flag-status|3.0.2)

    Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    22. Flag.category
    Definition

    Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

    ShortClinical, administrative, etc.
    Control0..1
    BindingFor example codes, see Flag Category .
    (example to http://hl7.org/fhir/ValueSet/flag-category|3.0.2)

    A general category for flags for filtering/display purposes.

    TypeCodeableConcept
    Summarytrue
    24. Flag.code
    Definition

    The coded value or textual component of the flag to display to the user.

    ShortCoded or textual message to display to user
    Comments

    If non coded, use CodeableConcept.text. This element should always be included in the narrative.

    Control1..1
    BindingFor example codes, see Flag Code
    (example to http://hl7.org/fhir/ValueSet/flag-code|1.0.0)

    Detail codes identifying specific flagged issues.

    TypeCodeableConcept
    Summarytrue
    26. Flag.subject
    Definition

    The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.

    ShortWho/What is flag about?
    Control1..1
    TypeReference(Patient, Location, Group, Organization, Practitioner, PlanDefinition, Medication, Procedure)
    Summarytrue
    28. Flag.period
    Definition

    The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

    ShortTime period when flag is active
    Control0..1
    TypePeriod
    Summarytrue
    30. Flag.encounter
    Definition

    This alert is only relevant during the encounter.

    ShortAlert relevant during encounter
    Comments

    If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.

    Control0..1
    TypeReference(Encounter)
    Summarytrue
    32. Flag.author
    Definition

    The person, organization or device that created the flag.

    ShortFlag creator
    Control0..1
    TypeReference(Device, Organization, Patient, Practitioner)
    Summarytrue
    34. Flag.author.id
    Definition

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

    Shortxml:id (or equivalent in JSON)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    36. Flag.author.extension
    Definition

    An Extension

    ShortExtension
    Control0..*
    TypeExtension
    SlicingThis element introduces a set of slices on Flag.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 38. Flag.author.extension:author
      Slice Nameauthor
      Definition

      R4: Flag.author

      ShortR4: author
      Comments

      Element Flag.author is mapped to FHIR STU3 element Flag.author as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element Flag.author with unmapped reference targets: PractitionerRole.

      Control0..1
      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
      40. Flag.author.reference
      Definition

      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

      ShortLiteral reference, Relative, internal or absolute URL
      Comments

      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

      Control0..1
      This element is affected by the following invariants: ref-1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      42. Flag.author.identifier
      Definition

      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

      ShortLogical reference, when literal reference is not known
      Comments

      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier
      Summarytrue
      44. Flag.author.display
      Definition

      Plain text narrative that identifies the resource in addition to the resource reference.

      ShortText alternative for the resource
      Comments

      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue