New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft

New Zealand Rheumatic Fever FHIR Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-rheumatic-fever/ and changes regularly. See the Directory of published versions

Resource Profile: Rheumatic Fever Condition

Official URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-condition Version: 1.0.0
Draft as of 2025-10-02 Computable Name: RheumaticFeverCondition

Extends NzCondition to add classifiers for RHD severity, diagnostic certainty and symptomatic status and specifies groups of diagnosic evidence that can be attached.

Adds classifiers for severity, diagnostic certainty and symptomatic status and specifies groups of diagnosic evidence to be attached

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5, RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for extension Content/Rules for all slices
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NationalSystem Σ 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS object id: CON-0206
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... code Σ 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... onset[x] Σ 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... recordedDate Σ 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder Σ 0..1 Reference(Practitioner) Who recorded the condition
... evidence C 0..3 BackboneElement Supporting evidence
Constraints: con-2
.... code ΣC 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail ΣC 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition 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-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules 0..0
... language 0..0
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... Slices for identifier 0..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... id 0..0
..... extension 0..0
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system 0..1 uri The namespace for the identifier value
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value 1..1 string The value that is unique
Example RFCCS object id: CON-0206
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
... code 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... subject 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... onset[x] 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... recordedDate 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder 0..1 Reference(Practitioner) Who recorded the condition
... stage 0..0
... evidence 0..3 BackboneElement Supporting evidence
.... extension 0..0
.... modifierExtension 0..0
.... code 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5, RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS object id: CON-0206
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... severity 0..1 CodeableConcept Subjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.
... code Σ 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... onset[x] Σ 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... abatement[x] C 0..1 When in resolution/remission
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recordedDate Σ 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder Σ 0..1 Reference(Practitioner) Who recorded the condition
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
... evidence C 0..3 BackboneElement Supporting evidence
Constraints: con-2
.... id 0..1 string Unique id for inter-element referencing
.... code ΣC 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail ΣC 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.severity Base preferred Condition/Diagnosis Severity 📍4.0.1 FHIR Std.
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📍4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📍4.0.1 FHIR Std.
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition 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-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5, RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for extension Content/Rules for all slices
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NationalSystem Σ 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS object id: CON-0206
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... code Σ 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... onset[x] Σ 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... recordedDate Σ 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder Σ 0..1 Reference(Practitioner) Who recorded the condition
... evidence C 0..3 BackboneElement Supporting evidence
Constraints: con-2
.... code ΣC 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail ΣC 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition 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-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules 0..0
... language 0..0
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... Slices for identifier 0..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... id 0..0
..... extension 0..0
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system 0..1 uri The namespace for the identifier value
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value 1..1 string The value that is unique
Example RFCCS object id: CON-0206
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
... code 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... subject 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... onset[x] 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... recordedDate 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder 0..1 Reference(Practitioner) Who recorded the condition
... stage 0..0
... evidence 0..3 BackboneElement Supporting evidence
.... extension 0..0
.... modifierExtension 0..0
.... code 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Condition C 0..* NzCondition Detailed information about conditions, problems or diagnoses
Constraints: con-3, con-4, con-5, RFConditionNZCategoryConstraint, RFConditionSNOMEDCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:long-term-condition 0..1 boolean Long Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
.... extension:rhdSeverity 0..1 Coding Severity of rheumatic heart disease
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
.... extension:diagnosticCertainty 0..1 Coding **This certainty code MUST be interpreted in conjunction with the patient's diagnosis in the .code element**
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Rheumatic fever certainty of diagnosis codes (required)
.... extension:assessmentDate 0..1 dateTime date (dateTime value in UTC timezone) of RHD severity assessment
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-assessmentdate
.... extension:symptomStatusAtDiagnosis 0..1 Coding Symptom status at diagnosis
URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-condition-symptomaticAtDiagnosis
Binding: Codes for rheumatic heart disease symptom status at time of diagnosis (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ 0..* Identifier This stores the identifier of the corresponding record in the national system (RFCCS) to let it be kept in sync with FHIR.
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: External identifier type codes (required)
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS object id: CON-0206
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... clinicalStatus ?!ΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.
... verificationStatus ?!ΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: ConditionVerificationStatus (required): The verification status to support or decline the clinical status of the condition or diagnosis.
... category 1..* CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.
... severity 0..1 CodeableConcept Subjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.
... code Σ 1..1 CodeableConcept Must be one of the diagnosis codes
Binding: Codes for summary diagnosis of the rheumatic fever condition (required)
... bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... onset[x] Σ 0..1 dateTime The date (UTC dateTime) when rheumatic fever was thought to have begun
... abatement[x] C 0..1 When in resolution/remission
.... abatementDateTime dateTime
.... abatementAge Age
.... abatementPeriod Period
.... abatementRange Range
.... abatementString string
... recordedDate Σ 0..1 dateTime The date (UTC dateTime) of diagnosis
... recorder Σ 0..1 Reference(Practitioner) Who recorded the condition
... asserter Σ 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Person who asserts this condition
... evidence C 0..3 BackboneElement Supporting evidence
Constraints: con-2
.... id 0..1 string Unique id for inter-element referencing
.... code ΣC 0..* CodeableConcept Identifies the GROUPing of diagnosis data in the linked Observation instance
Binding: Codes for rheumatic fever diagnosis observation grouping (preferred)
.... detail ΣC 0..* Reference(Rheumatic Fever Diagnosis Group) Links up to 3 Observation instances (all using the RF diagnosis group profile) to represent diagnosis detail
... note 0..* Annotation Additional information about the Condition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Condition.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Condition.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
Condition.clinicalStatus Base required Condition Clinical Status Codes 📍4.0.1 FHIR Std.
Condition.verificationStatus Base required ConditionVerificationStatus 📍4.0.1 FHIR Std.
Condition.category Base extensible Condition Category Codes 📍4.0.1 FHIR Std.
Condition.severity Base preferred Condition/Diagnosis Severity 📍4.0.1 FHIR Std.
Condition.code Base required Codes for summary diagnosis of the rheumatic fever condition 📦1.0.0 This IG
Condition.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Condition.stage.summary Base example Condition Stage 📍4.0.1 FHIR Std.
Condition.stage.type Base example Condition Stage Type 📍4.0.1 FHIR Std.
Condition.evidence.code Base preferred Codes for rheumatic fever diagnosis observation grouping 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
RFConditionNZCategoryConstraint error Condition All RF Condition instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) Condition.category.where(coding.code='rf-nz').exists()
RFConditionSNOMEDCategoryConstraint error Condition All RF Condition instances shall have a category SNOMED #58718002 'Rheumatic fever (disorder)' Condition.category.where(coding.code='58718002').exists()
RFNZTagConstraint error Condition.meta All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) tag.code contains 'rf-nz'
con-2 error Condition.evidence evidence SHALL have code or details code.exists() or detail.exists()
con-3 best practice Condition Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
con-4 error Condition If condition is abated, then clinicalStatus must be either inactive, resolved, or remission abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
con-5 error Condition Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
dom-2 error Condition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Condition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Condition 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-5 error Condition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Condition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron