STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: Sex of patient assigned at birth

URL for this extension:

http://hl7.org/fhir/StructureDefinition/us-core-birthsex

Status: draft. Extension maintained by: Health Level Seven International (US Realm Steering Committee)

A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

Context of Use: Use on element: Patient

usage info: insert a list of places where this extension is used

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/us-core-birthsex Sex of patient assigned at birth: A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). Use on element: Patient
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/us-core-birthsex Sex of patient assigned at birth: A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). Use on element: Patient
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/us-core-birthsex"
valueCode	1..1	code	Value of extension Binding: USRealm Birth Sex Value Set (required)
Documentation for this format

XML Template

<!-- Sex of patient assigned at birth -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-birthsex" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // Sex of patient assigned at birth
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-birthsex", // R! 
    "valueCode" : "<code>" // R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	code	URL = http://hl7.org/fhir/StructureDefinition/us-core-birthsex Sex of patient assigned at birth: A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). Use on element: Patient
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/us-core-birthsex Sex of patient assigned at birth: A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc). Use on element: Patient
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/us-core-birthsex"
valueCode	1..1	code	Value of extension Binding: USRealm Birth Sex Value Set (required)
Documentation for this format

XML Template

<!-- Sex of patient assigned at birth -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/us-core-birthsex" >
  <!-- from Element: extension -->
 <valueCode value="[code]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // Sex of patient assigned at birth
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/us-core-birthsex", // R! 
    "valueCode" : "<code>" // R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))