Health NZ | Te Whatu Ora FHIR Assistance Needs Questionnaires Implementation Guide
0.0.1 - draft

Health NZ | Te Whatu Ora FHIR Assistance Needs Questionnaires Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-patient-questionnaires/ and changes regularly. See the Directory of published versions

Resource Profile: Assistance Needs Profle

Official URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-profile Version: 0.0.1
Draft as of 2024-08-19 Computable Name: AssistanceNeedsProfile

Extension of Conditions for capturing Patient assistance needs

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Condition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..* Condition Detailed information about conditions, problems or diagnoses
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... verificationStatus 0..0
... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..0
.... onset[x]:onsetPeriod 0..0
.... onset[x]:onsetRange 0..0
.... onset[x]:onsetString 0..0
... Slices for abatement[x] 0..1 dateTime, Age, Period, Range, string When in resolution/remission
Slice: Unordered, Open by type:$this
.... abatement[x]:abatementDateTime 0..0
.... abatement[x]:abatementAge 0..0
.... abatement[x]:abatementPeriod 0..0
.... abatement[x]:abatementRange 0..0
.... abatement[x]:abatementString 0..0
... recordedDate 0..0
... stage 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* Condition Detailed information about conditions, problems or diagnoses
con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... subject Σ 1..1 Reference(Patient | Group) Who has the condition?
... Slices for onset[x] Σ 0..1 Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... Slices for abatement[x] C 0..1 When in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* Condition Detailed information about conditions, problems or diagnoses
con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this condition
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... code Σ 0..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.

... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ 1..1 Reference(Patient | Group) Who has the condition?
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... Slices for onset[x] Σ 0..1 Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... Slices for abatement[x] C 0..1 When in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the condition
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
... evidence C 0..* BackboneElement Supporting evidence
con-2: evidence SHALL have code or details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC 0..* CodeableConcept Manifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣC 0..* Reference(Resource) Supporting information found elsewhere
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Condition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Condition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Condition.stage.summaryexampleConditionStage
http://hl7.org/fhir/ValueSet/condition-stage
from the FHIR Standard
Condition.stage.typeexampleConditionStageType
http://hl7.org/fhir/ValueSet/condition-stage-type
from the FHIR Standard
Condition.evidence.codeexampleManifestationAndSymptomCodes
http://hl7.org/fhir/ValueSet/manifestation-or-symptom
from the FHIR Standard

This structure is derived from Condition

Summary

Prohibited: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Condition.onset[x]
  • The element 1 is sliced based on the value of Condition.abatement[x]

Differential View

This structure is derived from Condition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..* Condition Detailed information about conditions, problems or diagnoses
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... verificationStatus 0..0
... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
... Slices for onset[x] 0..1 dateTime, Age, Period, Range, string Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onset[x]:onsetDateTime 0..0
.... onset[x]:onsetPeriod 0..0
.... onset[x]:onsetRange 0..0
.... onset[x]:onsetString 0..0
... Slices for abatement[x] 0..1 dateTime, Age, Period, Range, string When in resolution/remission
Slice: Unordered, Open by type:$this
.... abatement[x]:abatementDateTime 0..0
.... abatement[x]:abatementAge 0..0
.... abatement[x]:abatementPeriod 0..0
.... abatement[x]:abatementRange 0..0
.... abatement[x]:abatementString 0..0
... recordedDate 0..0
... stage 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* Condition Detailed information about conditions, problems or diagnoses
con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... subject Σ 1..1 Reference(Patient | Group) Who has the condition?
... Slices for onset[x] Σ 0..1 Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... Slices for abatement[x] C 0..1 When in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* Condition Detailed information about conditions, problems or diagnoses
con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extend Condition to capture assistance needs based on CodeSet
Slice: Unordered, Open by value:url
.... assistanceNeeds 0..* CodeableConcept Assistance Needs
URL: https://fhir-ig.digital.health.nz/fhir-patient-questionnaires/StructureDefinition/assistance-needs-ext
Binding: Assistance Needs ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this condition
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... category 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... code Σ 0..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the condition or diagnosis.

... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ 1..1 Reference(Patient | Group) Who has the condition?
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... Slices for onset[x] Σ 0..1 Estimated or actual date, date-time, or age
Slice: Unordered, Open by type:$this
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... Slices for abatement[x] C 0..1 When in resolution/remission
Slice: Unordered, Closed by type:$this
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recorder Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who recorded the condition
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
... evidence C 0..* BackboneElement Supporting evidence
con-2: evidence SHALL have code or details
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code ΣC 0..* CodeableConcept Manifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣC 0..* Reference(Resource) Supporting information found elsewhere
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Condition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
Condition.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Condition.stage.summaryexampleConditionStage
http://hl7.org/fhir/ValueSet/condition-stage
from the FHIR Standard
Condition.stage.typeexampleConditionStageType
http://hl7.org/fhir/ValueSet/condition-stage-type
from the FHIR Standard
Condition.evidence.codeexampleManifestationAndSymptomCodes
http://hl7.org/fhir/ValueSet/manifestation-or-symptom
from the FHIR Standard

This structure is derived from Condition

Summary

Prohibited: 13 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Condition.onset[x]
  • The element 1 is sliced based on the value of Condition.abatement[x]

 

Other representations of profile: CSV, Excel, Schematron