Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_Person_R5

Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-Person Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R2_Person_R5

This cross-version profile allows DSTU2 Person content to be represented via FHIR R5 Person resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Person If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error Person.implicitRules, Person.modifierExtension, Person.active All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Person.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..* HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.name
... telecom
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.address
... photo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:photo 0..1 Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.photo
... managingOrganization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:managingOrganization 0..1 Reference(Resource) DSTU2: managingOrganization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... link
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) DSTU2: target
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
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)
... active ?!Σ 0..1 boolean This person's record is in active use
... name Σ 0..* HumanName A name associated with the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..* HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.name
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem . (required): Telecommunications form for contact point.
.... value ΣC 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the person was born
... deceased[x] Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address One or more addresses for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a person
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
... photo 0..* Attachment Image of the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:photo 0..1 Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.photo
Constraints: ext-1
.... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
.... data C 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages
... communication 0..* BackboneElement A language which may be used to communicate with the person about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the person about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator
... managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:managingOrganization 0..1 Reference(Resource) DSTU2: managingOrganization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... link 0..* BackboneElement Link to a resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) DSTU2: target
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... assurance 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Person.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Person.language Base required All Languages 📍5.0.0 FHIR Std.
Person.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Person.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Person.identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Person.name.use Base required NameUse 📍5.0.0 FHIR Std.
Person.telecom.system Base required ContactPointSystem . 📍5.0.0 tx.fhir.org
Person.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Person.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Person.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Person.address.type Base required AddressType 📍5.0.0 FHIR Std.
Person.maritalStatus Base extensible Marital Status Codes 📍5.0.0 FHIR Std.
Person.photo.contentType Base required Mime Types 📍5.0.0 FHIR Std.
Person.photo.language Base required All Languages 📍5.0.0 FHIR Std.
Person.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Person.managingOrganization.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Person.link.target.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Person.link.assurance Base required Identity Assurance Level 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Person If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error Person.meta, Person.meta.extension, Person.meta.extension:meta, Person.meta.versionId, Person.meta.lastUpdated, Person.meta.source, Person.meta.profile, Person.meta.security, Person.meta.tag, Person.implicitRules, Person.language, Person.text, Person.text.extension, Person.text.extension:text, Person.text.status, Person.text.div, Person.extension, Person.modifierExtension, Person.identifier, Person.identifier.extension, Person.identifier.extension:identifier, Person.identifier.use, Person.identifier.type, Person.identifier.system, Person.identifier.value, Person.identifier.period, Person.identifier.assigner, Person.active, Person.name, Person.name.extension, Person.name.extension:name, Person.name.use, Person.name.text, Person.name.family, Person.name.given, Person.name.prefix, Person.name.suffix, Person.name.period, Person.telecom, Person.telecom.extension, Person.telecom.extension:telecom, Person.telecom.system, Person.telecom.value, Person.telecom.use, Person.telecom.rank, Person.telecom.period, Person.gender, Person.birthDate, Person.deceased[x], Person.address, Person.address.extension, Person.address.extension:address, Person.address.use, Person.address.type, Person.address.text, Person.address.line, Person.address.city, Person.address.district, Person.address.state, Person.address.postalCode, Person.address.country, Person.address.period, Person.maritalStatus, Person.photo, Person.photo.extension, Person.photo.extension:photo, Person.photo.contentType, Person.photo.language, Person.photo.data, Person.photo.url, Person.photo.size, Person.photo.hash, Person.photo.title, Person.photo.creation, Person.photo.height, Person.photo.width, Person.photo.frames, Person.photo.duration, Person.photo.pages, Person.communication, Person.communication.extension, Person.communication.modifierExtension, Person.communication.language, Person.communication.preferred, Person.managingOrganization, Person.managingOrganization.extension, Person.managingOrganization.extension:managingOrganization, Person.managingOrganization.reference, Person.managingOrganization.type, Person.managingOrganization.identifier, Person.managingOrganization.display, Person.link, Person.link.extension, Person.link.modifierExtension, Person.link.target, Person.link.target.extension, Person.link.target.extension:target, Person.link.target.reference, Person.link.target.type, Person.link.target.identifier, Person.link.target.display, Person.link.assurance All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Person.meta.extension, Person.meta.extension:meta, Person.text.extension, Person.text.extension:text, Person.extension, Person.modifierExtension, Person.identifier.extension, Person.identifier.extension:identifier, Person.name.extension, Person.name.extension:name, Person.telecom.extension, Person.telecom.extension:telecom, Person.address.extension, Person.address.extension:address, Person.photo.extension, Person.photo.extension:photo, Person.communication.extension, Person.communication.modifierExtension, Person.managingOrganization.extension, Person.managingOrganization.extension:managingOrganization, Person.link.extension, Person.link.modifierExtension, Person.link.target.extension, Person.link.target.extension:target Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Person.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Person.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Person If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error Person.implicitRules, Person.modifierExtension, Person.active All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Person.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Person

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..* HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.name
... telecom
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.address
... photo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:photo 0..1 Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.photo
... managingOrganization
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:managingOrganization 0..1 Reference(Resource) DSTU2: managingOrganization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... link
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) DSTU2: target
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Person 0..* Person(5.0.0) A generic person record
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
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)
... active ?!Σ 0..1 boolean This person's record is in active use
... name Σ 0..* HumanName A name associated with the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..* HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.name
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem . (required): Telecommunications form for contact point.
.... value ΣC 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the person was born
... deceased[x] Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address One or more addresses for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a person
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
... photo 0..* Attachment Image of the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:photo 0..1 Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Person.photo
Constraints: ext-1
.... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
.... data C 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages
... communication 0..* BackboneElement A language which may be used to communicate with the person about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the person about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator
... managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:managingOrganization 0..1 Reference(Resource) DSTU2: managingOrganization additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... link 0..* BackboneElement Link to a resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) DSTU2: target
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... assurance 0..1 code level1 | level2 | level3 | level4
Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Person.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Person.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Person.language Base required All Languages 📍5.0.0 FHIR Std.
Person.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Person.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Person.identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Person.name.use Base required NameUse 📍5.0.0 FHIR Std.
Person.telecom.system Base required ContactPointSystem . 📍5.0.0 tx.fhir.org
Person.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Person.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Person.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Person.address.type Base required AddressType 📍5.0.0 FHIR Std.
Person.maritalStatus Base extensible Marital Status Codes 📍5.0.0 FHIR Std.
Person.photo.contentType Base required Mime Types 📍5.0.0 FHIR Std.
Person.photo.language Base required All Languages 📍5.0.0 FHIR Std.
Person.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Person.managingOrganization.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Person.link.target.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Person.link.assurance Base required Identity Assurance Level 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Person If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Person 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 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Person If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Person If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Person A resource should have narrative for robust management text.`div`.exists()
ele-1 error Person.meta, Person.meta.extension, Person.meta.extension:meta, Person.meta.versionId, Person.meta.lastUpdated, Person.meta.source, Person.meta.profile, Person.meta.security, Person.meta.tag, Person.implicitRules, Person.language, Person.text, Person.text.extension, Person.text.extension:text, Person.text.status, Person.text.div, Person.extension, Person.modifierExtension, Person.identifier, Person.identifier.extension, Person.identifier.extension:identifier, Person.identifier.use, Person.identifier.type, Person.identifier.system, Person.identifier.value, Person.identifier.period, Person.identifier.assigner, Person.active, Person.name, Person.name.extension, Person.name.extension:name, Person.name.use, Person.name.text, Person.name.family, Person.name.given, Person.name.prefix, Person.name.suffix, Person.name.period, Person.telecom, Person.telecom.extension, Person.telecom.extension:telecom, Person.telecom.system, Person.telecom.value, Person.telecom.use, Person.telecom.rank, Person.telecom.period, Person.gender, Person.birthDate, Person.deceased[x], Person.address, Person.address.extension, Person.address.extension:address, Person.address.use, Person.address.type, Person.address.text, Person.address.line, Person.address.city, Person.address.district, Person.address.state, Person.address.postalCode, Person.address.country, Person.address.period, Person.maritalStatus, Person.photo, Person.photo.extension, Person.photo.extension:photo, Person.photo.contentType, Person.photo.language, Person.photo.data, Person.photo.url, Person.photo.size, Person.photo.hash, Person.photo.title, Person.photo.creation, Person.photo.height, Person.photo.width, Person.photo.frames, Person.photo.duration, Person.photo.pages, Person.communication, Person.communication.extension, Person.communication.modifierExtension, Person.communication.language, Person.communication.preferred, Person.managingOrganization, Person.managingOrganization.extension, Person.managingOrganization.extension:managingOrganization, Person.managingOrganization.reference, Person.managingOrganization.type, Person.managingOrganization.identifier, Person.managingOrganization.display, Person.link, Person.link.extension, Person.link.modifierExtension, Person.link.target, Person.link.target.extension, Person.link.target.extension:target, Person.link.target.reference, Person.link.target.type, Person.link.target.identifier, Person.link.target.display, Person.link.assurance All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Person.meta.extension, Person.meta.extension:meta, Person.text.extension, Person.text.extension:text, Person.extension, Person.modifierExtension, Person.identifier.extension, Person.identifier.extension:identifier, Person.name.extension, Person.name.extension:name, Person.telecom.extension, Person.telecom.extension:telecom, Person.address.extension, Person.address.extension:address, Person.photo.extension, Person.photo.extension:photo, Person.communication.extension, Person.communication.modifierExtension, Person.managingOrganization.extension, Person.managingOrganization.extension:managingOrganization, Person.link.extension, Person.link.modifierExtension, Person.link.target.extension, Person.link.target.extension:target Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Person.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Person.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron