Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Rheumatic Fever Condition

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-rheumaticfever-condition Version: 1.0.0
Active as of 2024-03-22 Computable Name: RheumaticFeverCondition

This profile contains diagnosis code and adds rheumatic heart disease severity and diagnosis certainty extensions to the base NzCondition resource.

Profiles a condition to add severity and diagnostic certainty classifiers and an extra assessment date for capture of NZ rheumatic fever case registration data

Warning: The IG official Url will be changing

The official Url of this Implementation Guide is expected to change in early 2024.

The Url domain will move to digital.health.nz and the IG will likely be renamed.

Developers of applications that consume this API are advised to make the official Url base configurable in their applications – the base Url is currently https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/


Usage:

Formal Views of Profile Content

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

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition NzCondition
... implicitRules 0..0
... language 0..0
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... assessmentDate C0..1dateDate of assessment of rheumatic heart disease severity
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-assessmentdate
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... Slices for identifier 0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... id 0..0
..... extension 0..0
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system 0..1uriThe namespace for the identifier value
Example General: Uri that defines the type of external identifier
..... value 1..1stringThe value that is unique
Example Salesforce object id: CON-0206
... code 1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... subject 1..1Reference(Patient)Who has the condition?
... onset[x] C0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recordedDate C0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder 0..1Reference(Practitioner)Who recorded the condition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*NzConditionDetailed 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
... long-term-condition 0..1booleanLong Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... diagnosticCertainty 0..1CodingCertainty of rheumatic fever diagnosis
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Codes for certainty of rheumatic fever diagnosis (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Salesforce object id: CON-0206
... clinicalStatus ?!ΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣC0..1CodeableConceptunconfirmed | 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.

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... subject Σ1..1Reference(Patient)Who has the condition?
... onset[x] ΣC0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recordedDate ΣC0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder Σ0..1Reference(Practitioner)Who recorded the condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
from the FHIR Standard
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*NzConditionDetailed 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... long-term-condition 0..1booleanLong Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... diagnosticCertainty 0..1CodingCertainty of rheumatic fever diagnosis
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Codes for certainty of rheumatic fever diagnosis (required)
... assessmentDate C0..1dateDate of assessment of rheumatic heart disease severity
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-assessmentdate
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Salesforce object id: CON-0206
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... clinicalStatus ?!ΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣC0..1CodeableConceptunconfirmed | 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 0..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ1..1Reference(Patient)Who has the condition?
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... onset[x] ΣC0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... abatement[x] C0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate ΣC0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder Σ0..1Reference(Practitioner)Who recorded the condition
... asserter Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Person who asserts this condition
... stage C0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary C0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment C0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence C0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣC0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.severitypreferredCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
from the FHIR Standard
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG
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

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from NzCondition

Summary

Mandatory: 1 element (3 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Condition.identifier is sliced based on the value of value:use

Differential View

This structure is derived from NzCondition

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition NzCondition
... implicitRules 0..0
... language 0..0
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... assessmentDate C0..1dateDate of assessment of rheumatic heart disease severity
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-assessmentdate
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... Slices for identifier 0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... id 0..0
..... extension 0..0
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system 0..1uriThe namespace for the identifier value
Example General: Uri that defines the type of external identifier
..... value 1..1stringThe value that is unique
Example Salesforce object id: CON-0206
... code 1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... subject 1..1Reference(Patient)Who has the condition?
... onset[x] C0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recordedDate C0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder 0..1Reference(Practitioner)Who recorded the condition

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*NzConditionDetailed 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
... long-term-condition 0..1booleanLong Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... diagnosticCertainty 0..1CodingCertainty of rheumatic fever diagnosis
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Codes for certainty of rheumatic fever diagnosis (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Salesforce object id: CON-0206
... clinicalStatus ?!ΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣC0..1CodeableConceptunconfirmed | 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.

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... subject Σ1..1Reference(Patient)Who has the condition?
... onset[x] ΣC0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recordedDate ΣC0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder Σ0..1Reference(Practitioner)Who recorded the condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
from the FHIR Standard
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C0..*NzConditionDetailed 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... long-term-condition 0..1booleanLong Term Condition Indicator
URL: http://hl7.org.nz/fhir/StructureDefinition/long-term-condition
... rhdSeverity 0..1CodingSeverity of rheumatic heart disease
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-rhdseverity
Binding: Rheumatic heart disease severity codes (required)
... diagnosticCertainty 0..1CodingCertainty of rheumatic fever diagnosis
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-diagnosticcertainty
Binding: Codes for certainty of rheumatic fever diagnosis (required)
... assessmentDate C0..1dateDate of assessment of rheumatic heart disease severity
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-condition-assessmentdate
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis slice lets clients link rheumatic fever conditions to corresponding records in external systems eg. Salesforce, EPISurv
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Salesforce object id: CON-0206
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... clinicalStatus ?!ΣC0..1CodeableConceptactive | recurrence | relapse | inactive | remission | resolved
Binding: ConditionClinicalStatusCodes (required): The clinical status of the condition or diagnosis.

... verificationStatus ?!ΣC0..1CodeableConceptunconfirmed | 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 0..*CodeableConceptproblem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


... severity 0..1CodeableConceptSubjective severity of condition
Binding: Condition/DiagnosisSeverity (preferred): A subjective assessment of the severity of the condition as evaluated by the clinician.

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Codes for rheumatic fever condition as diagnosed at patient registration (required)
... bodySite Σ0..*CodeableConceptAnatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... subject Σ1..1Reference(Patient)Who has the condition?
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... onset[x] ΣC0..1dateTimeEstimated or actual date, date-time, or age
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... abatement[x] C0..1When in resolution/remission
.... abatementDateTimedateTime
.... abatementAgeAge
.... abatementPeriodPeriod
.... abatementRangeRange
.... abatementStringstring
... recordedDate ΣC0..1dateTimeDate record was first recorded
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
... recorder Σ0..1Reference(Practitioner)Who recorded the condition
... asserter Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)Person who asserts this condition
... stage C0..*BackboneElementStage/grade, usually assessed formally
con-1: Stage SHALL have summary or assessment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... summary C0..1CodeableConceptSimple summary (disease specific)
Binding: ConditionStage (example): Codes describing condition stages (e.g. Cancer stages).

.... assessment C0..*Reference(ClinicalImpression | DiagnosticReport | Observation)Formal record of assessment
.... type 0..1CodeableConceptKind of staging
Binding: ConditionStageType (example): Codes describing the kind of condition staging (e.g. clinical or pathological).

... evidence C0..*BackboneElementSupporting evidence
con-2: evidence SHALL have code or details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣC0..*CodeableConceptManifestation/symptom
Binding: ManifestationAndSymptomCodes (example): Codes that describe the manifestation or symptoms of a condition.


.... detail ΣC0..*Reference(Resource)Supporting information found elsewhere
... note 0..*AnnotationAdditional information about the Condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
Condition.clinicalStatusrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1
from the FHIR Standard
Condition.verificationStatusrequiredConditionVerificationStatus
http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1
from the FHIR Standard
Condition.categoryextensibleConditionCategoryCodes
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.severitypreferredCondition/DiagnosisSeverity
http://hl7.org/fhir/ValueSet/condition-severity
from the FHIR Standard
Condition.coderequiredRheumaticFeverConditionDiagnosisAtRegistrationValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-condition-diagnosisatregistration-code
from this IG
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

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningCondition.extension:assessmentDate, Condition.onset[x], Condition.recordedDateValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from NzCondition

Summary

Mandatory: 1 element (3 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Condition.identifier is sliced based on the value of value:use

 

Other representations of profile: CSV, Excel, Schematron