This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

D.4.1 StructureDefinition: DAF-core-patient

This profile sets minimum expectations for the Patient resource to record, search and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the DAF Patient profile:

• Query for a Patient demographic information using Medical Record Number (MRN), which is a type of identifier. The MRN is identifiable by identifier.system and may be location specific.
• Query for a Patient demographic information using first name, last name etc.
• Query for Patients based on race, ethnicity, gender etc.
• Query for Patients less than 5 years of age
• Query for Patients between ages of 25 and 50

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Patient must have:

1. a patient identifier (e.g. MRN)
2. a patient name
3. a gender

2015 Edition Certification Requirements (Must Support).

In addition, based upon the 2015 Edition Certification Requirements, the following data-elements must be supported.

’'’If the data is present, Patient shall include:’’’

1. a birth date
2. a communication language
3. a race
4. an ethnicity
5. a birth sex

Profile specific implementation guidance:

• none

Example: Patient Example: example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-patient

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Terminology Bindings

Terminology Bindings

Path	Name	Conformance	ValueSet
Patient.language	Common Languages	extensible	Common Languages
Patient.extension.valueCodeableConcept	v3 Code System Race	required	v3 Code System Race
Patient.extension.valueCodeableConcept.coding	v3 Code System Race	extensible	v3 Code System Race
Patient.extension.valueCodeableConcept.coding	v3 Code System Race	extensible	v3 Code System Race
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-ethnicity	Ethnicity group	required	Ethnicity group
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-birthsex	USRealm Birth Sex Value Set	required	USRealm Birth Sex Value Set
Patient.identifier.use	IdentifierUse	required	IdentifierUse
Patient.identifier.type	Identifier Type Codes	extensible	Identifier Type Codes
Patient.name.use	NameUse	required	NameUse
Patient.gender	AdministrativeGender	required	AdministrativeGender
Patient.maritalStatus	Marital Status Codes	required	Marital Status Codes
Patient.contact.relationship	v2 Contact Role	extensible	v2 Contact Role
Patient.contact.gender	AdministrativeGender	required	AdministrativeGender
Patient.animal.species	AnimalSpecies	example	AnimalSpecies
Patient.animal.breed	AnimalBreeds	example	AnimalBreeds
Patient.animal.genderStatus	GenderStatus	example	GenderStatus
Patient.communication.language	Common Languages	required	Common Languages
Patient.link.type	LinkType	required	LinkType

D.4.1.3 Constraints

Constraints

Id	Path	Details	Requirements
dom-2	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained)
dom-1	Patient	If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text)
dom-4	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1	Patient.extension	All FHIR elements must have a @value or children XPath: @value|f:*|h:div
ext-1	Patient.extension	Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1	Patient.extension	All FHIR elements must have a @value or children XPath: @value|f:*|h:div
ext-1	Patient.extension	Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1	Patient.extension	All FHIR elements must have a @value or children XPath: @value|f:*|h:div
ext-1	Patient.extension	Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1	Patient.extension	All FHIR elements must have a @value or children XPath: @value|f:*|h:div
ext-1	Patient.extension	Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
pat-1	Patient.contact	SHALL at least contain a contact's details or a reference to an organization XPath: exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)

.