JohnMoehrke PHR FHIR API
0.5.2 - ci-build United States of America flag

JohnMoehrke PHR FHIR API, published by John Moehrke (himself). This guide is not an authorized publication; it is the continuous build for version 0.5.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/JohnMoehrke/phr/ and changes regularly. See the Directory of published versions

Resource Profile: VA MHV PHR problems

Official URL: http://johnmoehrke.github.io/phr/StructureDefinition/JFM.PHR.condition Version: 0.5.2
Standards status: Trial-use Maturity Level: 4 Computable Name: JFMcondition

A profile on the Condition resource for MHV PHR exposing Problems using FHIR API.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* USCoreConditionProblemsHealthConcernsProfile 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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:assertedDate S 0..1 dateTime Date the condition was first asserted
URL: http://hl7.org/fhir/StructureDefinition/condition-assertedDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:TOid Σ 1..* Identifier External Ids for this condition
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
ele-1: All FHIR elements must have a @value or children
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category S 1..* CodeableConcept category codes
Slice: Unordered, Open by pattern:$this
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
.... category:us-core S 1..* CodeableConcept problem-list-item | health-concern
Binding: US Core Problem or Health Concern (required)
ele-1: All FHIR elements must have a @value or children
.... category:sdoh S 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: sdoh
... code SΣ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: US Core Condition Codes (extensible): Valueset to describe the actual problem experienced by the patient


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who has the condition?
ele-1: All FHIR elements must have a @value or children
... onset[x] SΣ 0..1 dateTime Estimated or actual date, date-time, or age
ele-1: All FHIR elements must have a @value or children
... abatement[x] SC 0..1 dateTime When in resolution/remission
ele-1: All FHIR elements must have a @value or children
... recordedDate SΣ 0..1 dateTime Date record was first recorded
ele-1: All FHIR elements must have a @value or children
... recorder SΣ 0..1 Reference(Practitioner) {c} Who recorded the condition
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Additional information about the Condition
ele-1: All FHIR elements must have a @value or children
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
.... time Σ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG
Condition.categoryextensiblePattern: problem-list-item
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.category:us-corerequiredUSCoreProblemOrHealthConcern
http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
Condition.category:sdohextensiblePattern: sdoh
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreConditionProblemsHealthConcernsProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..* USCoreConditionProblemsHealthConcernsProfile Detailed information about conditions, problems or diagnoses
... Slices for identifier 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:TOid 1..* Identifier External Ids for this condition
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
... clinicalStatus 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
... verificationStatus 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
... category 1..* CodeableConcept category codes
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
... severity 0..0
... code
.... coding S 1..1 Coding Code defined by a terminology system
.... text S 1..1 string Plain text representation of the concept
... bodySite 0..0
... subject 1..1 Reference(US Core Patient Profile) Who has the condition?
... encounter 0..0
... onset[x] 0..1 dateTime Estimated or actual date, date-time, or age
... abatement[x] 0..1 dateTime When in resolution/remission
... recordedDate 0..1 dateTime Date record was first recorded
... recorder S 0..1 Reference(Practitioner) {c} Who recorded the condition
.... Slices for extension Content/Rules for all slices
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Location) {c} Value of extension
... asserter 0..0
... stage 0..0
... evidence 0..0
... note S 0..* Annotation Additional information about the Condition
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorString 0..1 string Individual responsible for the annotation
.... time 0..1 dateTime When the annotation was made
.... text 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* USCoreConditionProblemsHealthConcernsProfile 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:assertedDate S 0..1 dateTime Date the condition was first asserted
URL: http://hl7.org/fhir/StructureDefinition/condition-assertedDate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:TOid Σ 1..* Identifier External Ids for this condition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
Example General: 123456
..... 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 ?!SΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
... Slices for category S 1..* CodeableConcept category codes
Slice: Unordered, Open by pattern:$this
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
.... category:us-core S 1..* CodeableConcept problem-list-item | health-concern
Binding: US Core Problem or Health Concern (required)
.... category:sdoh S 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: sdoh
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: US Core Condition Codes (extensible): Valueset to describe the actual problem experienced by the patient

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
.... text SΣ 1..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who has the condition?
... onset[x] SΣ 0..1 dateTime S Estimated or actual date, date-time, or age
... abatement[x] SC 0..1 dateTime S When in resolution/remission
... recordedDate SΣ 0..1 dateTime Date record was first recorded
... recorder SΣ 0..1 Reference(Practitioner) {c} Who recorded the condition
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note S 0..* Annotation Additional information about the Condition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Condition.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG
Condition.categoryextensiblePattern: problem-list-item
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.category:us-corerequiredUSCoreProblemOrHealthConcern
http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
Condition.category:sdohextensiblePattern: sdoh
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
Condition.recorder.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreConditionProblemsHealthConcernsProfile

Summary

Mandatory: 5 elements
Must-Support: 4 elements
Prohibited: 6 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.identifier
  • The element 1 is sliced based on the value of Condition.note.author[x]

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* USCoreConditionProblemsHealthConcernsProfile 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
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension Content/Rules for all slices
.... extension:assertedDate S 0..1 dateTime Date the condition was first asserted
URL: http://hl7.org/fhir/StructureDefinition/condition-assertedDate
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:TOid Σ 1..* Identifier External Ids for this condition
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
Required Pattern: usual
..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
ele-1: All FHIR elements must have a @value or children
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... clinicalStatus ?!SΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
ele-1: All FHIR elements must have a @value or children
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category S 1..* CodeableConcept category codes
Slice: Unordered, Open by pattern:$this
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
.... category:us-core S 1..* CodeableConcept problem-list-item | health-concern
Binding: US Core Problem or Health Concern (required)
ele-1: All FHIR elements must have a @value or children
.... category:sdoh S 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: sdoh
... code SΣ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: US Core Condition Codes (extensible): Valueset to describe the actual problem experienced by the patient


ele-1: All FHIR elements must have a @value or children
.... coding SΣ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Who has the condition?
ele-1: All FHIR elements must have a @value or children
... onset[x] SΣ 0..1 dateTime Estimated or actual date, date-time, or age
ele-1: All FHIR elements must have a @value or children
... abatement[x] SC 0..1 dateTime When in resolution/remission
ele-1: All FHIR elements must have a @value or children
... recordedDate SΣ 0..1 dateTime Date record was first recorded
ele-1: All FHIR elements must have a @value or children
... recorder SΣ 0..1 Reference(Practitioner) {c} Who recorded the condition
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Additional information about the Condition
ele-1: All FHIR elements must have a @value or children
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
.... time Σ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text Σ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG
Condition.categoryextensiblePattern: problem-list-item
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.category:us-corerequiredUSCoreProblemOrHealthConcern
http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
Condition.category:sdohextensiblePattern: sdoh
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Differential View

This structure is derived from USCoreConditionProblemsHealthConcernsProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition 0..* USCoreConditionProblemsHealthConcernsProfile Detailed information about conditions, problems or diagnoses
... Slices for identifier 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:TOid 1..* Identifier External Ids for this condition
..... use 1..1 code usual | official | temp | secondary | old (If known)
Required Pattern: usual
..... system C 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
..... value 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
... clinicalStatus 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
... verificationStatus 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
... category 1..* CodeableConcept category codes
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
... severity 0..0
... code
.... coding S 1..1 Coding Code defined by a terminology system
.... text S 1..1 string Plain text representation of the concept
... bodySite 0..0
... subject 1..1 Reference(US Core Patient Profile) Who has the condition?
... encounter 0..0
... onset[x] 0..1 dateTime Estimated or actual date, date-time, or age
... abatement[x] 0..1 dateTime When in resolution/remission
... recordedDate 0..1 dateTime Date record was first recorded
... recorder S 0..1 Reference(Practitioner) {c} Who recorded the condition
.... Slices for extension Content/Rules for all slices
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... value[x] 1..1 Reference(Location) {c} Value of extension
... asserter 0..0
... stage 0..0
... evidence 0..0
... note S 0..* Annotation Additional information about the Condition
.... Slices for author[x] 0..1 Reference(Practitioner | Patient | RelatedPerson | Organization), string Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... author[x]:authorString 0..1 string Individual responsible for the annotation
.... time 0..1 dateTime When the annotation was made
.... text 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Condition C 0..* USCoreConditionProblemsHealthConcernsProfile 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:assertedDate S 0..1 dateTime Date the condition was first asserted
URL: http://hl7.org/fhir/StructureDefinition/condition-assertedDate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..* Identifier External Ids for this condition
Slice: Unordered, Open by value:use
.... identifier:TOid Σ 1..* Identifier External Ids for this condition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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 Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system ΣC 0..1 uri urn:oid:2.16.840.1.113883.4.349.4.{stationNbr}
TOid-startswithoid: ID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string `ProblemTO` | `.` | {ProblemTO.id}
Example General: 123456
..... 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 ?!SΣC 0..1 CodeableConcept active | recurrence | relapse | inactive | remission | resolved
Binding: Subset of condition clinical status (required)
... verificationStatus ?!SΣC 0..1 CodeableConcept unconfirmed | provisional | differential | confirmed | refuted | entered-in-error
Binding: Subset of condition verification status (required)
... Slices for category S 1..* CodeableConcept category codes
Slice: Unordered, Open by pattern:$this
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.



Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/condition-category
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: problem-list-item
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
.... category:us-core S 1..* CodeableConcept problem-list-item | health-concern
Binding: US Core Problem or Health Concern (required)
.... category:sdoh S 0..1 CodeableConcept problem-list-item | encounter-diagnosis
Binding: ConditionCategoryCodes (extensible): A category assigned to the condition.



Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-tags
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: sdoh
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code SΣ 1..1 CodeableConcept Identification of the condition, problem or diagnosis
Binding: US Core Condition Codes (extensible): Valueset to describe the actual problem experienced by the patient

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
.... text SΣ 1..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(US Core Patient Profile) Who has the condition?
... onset[x] SΣ 0..1 dateTime S Estimated or actual date, date-time, or age
... abatement[x] SC 0..1 dateTime S When in resolution/remission
... recordedDate SΣ 0..1 dateTime Date record was first recorded
... recorder SΣ 0..1 Reference(Practitioner) {c} Who recorded the condition
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:location 0..1 (Complex) Alternative reference (target type is wrong)
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
...... value[x] 1..1 Reference(Location) {c} Value of extension
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note S 0..* Annotation Additional information about the Condition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for author[x] Σ 0..1 Individual responsible for the annotation
Slice: Unordered, Open by type:$this
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
..... author[x]:authorString Σ 0..1 string Individual responsible for the annotation
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Condition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Condition.identifier:TOid.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Condition.identifier:TOid.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Condition.clinicalStatusrequiredConditionClinicalStatusVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionClinicalStatusVS
from this IG
Condition.verificationStatusrequiredConditionVerificationVS
http://johnmoehrke.github.io/phr/ValueSet/ConditionVerificationVS
from this IG
Condition.categoryextensiblePattern: problem-list-item
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.category:us-corerequiredUSCoreProblemOrHealthConcern
http://hl7.org/fhir/us/core/ValueSet/us-core-problem-or-health-concern
Condition.category:sdohextensiblePattern: sdoh
http://hl7.org/fhir/ValueSet/condition-category
from the FHIR Standard
Condition.codeextensibleUSCoreConditionCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code
Condition.recorder.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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
TOid-startswithoiderrorCondition.identifier:TOid.systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
: value.startsWith('urn:oid:2.16.840.1.113883.4.349.4.')

This structure is derived from USCoreConditionProblemsHealthConcernsProfile

Summary

Mandatory: 5 elements
Must-Support: 4 elements
Prohibited: 6 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.identifier
  • The element 1 is sliced based on the value of Condition.note.author[x]

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron