UCSDI5 Sandbox
0.0.0 - CI Build United States of America flag

UCSDI5 Sandbox - Local Development build (v0.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Patient Sex Parameter For Clinical Use (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse Version: 0.0.0
Standards status: Informative Computable Name: PatSexParameterForClinicalUse

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

This extension is a modified from the FHIR Standard Patient Sex Parameter For Clinical Use Extension to show how the .code element which is defined as a "code that has the same meaning as the element in a particular terminology" can be used to fulfil USCDI's Applicable Vocabulary Standard(s) = LOINC 99501-9 (Sex parameter for clinical use). It also displays the element in the slice and uses the loinc in the URL so it can be seen in the instance.

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource

This extension is a modified from the FHIR Standard Patient Sex Parameter For Clinical Use Extension to show how the .code element which is defined as a "code that has the same meaning as the element in a particular terminology" can be used to fulfil USCDI's Applicable Vocabulary Standard(s) = LOINC 99501-9 (Sex parameter for clinical use). It also displays the element in the slice and uses the loinc in the URL so it can be seen in the instance.

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: This extension is a modified from the FHIR Standard Patient Sex Parameter For Clinical Use Extension to show how the .code element which is defined as a "code that has the same meaning as the element in a particular terminology" can be used to fulfil USCDI's Applicable Vocabulary Standard(s) = LOINC 99501-9 (Sex parameter for clinical use). It also displays the element in the slice and uses the loinc in the URL so it can be seen in the instance.

  • value: CodeableConcept: A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..
  • period: Period: The time period during which the sex parameter for clinical use applies
  • comment: string: Further explanation about the choice, intention, or context of use for the sex parameter for clinical use
  • supportingInfo: Reference: Other clinical evidence or documentation that was used to determine the sex parameter for clincal use

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension A context-specific sex parameter for clinical use
... Slices for extension Content/Rules for all slices
.... extension:value 1..1 Extension A context-specific sex parameter for clinical use
..... extension 0..0
..... url 1..1 uri "http://loinc.org/99501-9/"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
.... extension:period 0..1 Extension When the sex for clinical use applies
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 1..1 Period Value of extension
.... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
..... extension 0..0
..... url 1..1 uri "comment"
..... value[x] 1..1 string Value of extension
.... extension:supportingInfo 0..* Extension Source of the sex for clincal use
..... extension 0..0
..... url 1..1 uri "supportingInfo"
..... value[x] 1..1 Reference(Resource) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension A context-specific sex parameter for clinical use
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:value 1..1 Extension A context-specific sex parameter for clinical use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://loinc.org/99501-9/"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
.... extension:period 0..1 Extension When the sex for clinical use applies
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 1..1 Period Value of extension
.... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "comment"
..... value[x] 1..1 string Value of extension
.... extension:supportingInfo 0..* Extension Source of the sex for clincal use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "supportingInfo"
..... value[x] 1..1 Reference(Resource) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension is a modified from the FHIR Standard Patient Sex Parameter For Clinical Use Extension to show how the .code element which is defined as a "code that has the same meaning as the element in a particular terminology" can be used to fulfil USCDI's Applicable Vocabulary Standard(s) = LOINC 99501-9 (Sex parameter for clinical use). It also displays the element in the slice and uses the loinc in the URL so it can be seen in the instance.

  • value: CodeableConcept: A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc..
  • period: Period: The time period during which the sex parameter for clinical use applies
  • comment: string: Further explanation about the choice, intention, or context of use for the sex parameter for clinical use
  • supportingInfo: Reference: Other clinical evidence or documentation that was used to determine the sex parameter for clincal use

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension A context-specific sex parameter for clinical use
... Slices for extension Content/Rules for all slices
.... extension:value 1..1 Extension A context-specific sex parameter for clinical use
..... extension 0..0
..... url 1..1 uri "http://loinc.org/99501-9/"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
.... extension:period 0..1 Extension When the sex for clinical use applies
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 1..1 Period Value of extension
.... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
..... extension 0..0
..... url 1..1 uri "comment"
..... value[x] 1..1 string Value of extension
.... extension:supportingInfo 0..* Extension Source of the sex for clincal use
..... extension 0..0
..... url 1..1 uri "supportingInfo"
..... value[x] 1..1 Reference(Resource) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension A context-specific sex parameter for clinical use
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:value 1..1 Extension A context-specific sex parameter for clinical use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://loinc.org/99501-9/"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Sex Parameter for Clinical Use (required)
.... extension:period 0..1 Extension When the sex for clinical use applies
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "period"
..... value[x] 1..1 Period Value of extension
.... extension:comment 0..1 Extension Comments about the sex parameter for clinical use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "comment"
..... value[x] 1..1 string Value of extension
.... extension:supportingInfo 0..* Extension Source of the sex for clincal use
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "supportingInfo"
..... value[x] 1..1 Reference(Resource) Value of extension
... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:value.value[x]requiredSexParameterForClinicalUse
http://terminology.hl7.org/ValueSet/sex-parameter-for-clinical-use

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()