Profiles

Viktor's Test Patient

Tree

Patient			Patient	There are no (further) constraints on this element Data Type Patient
extension				There are no (further) constraints on this element Element Id Patient.extension Sliced: Unordered, Open, by url(Value)
birthPlace			Extension(Address)	There are no (further) constraints on this element Element Id Patient.extension:birthPlace Data Type Extension(Address) Extension URL http://hl7.org/fhir/StructureDefinition/birthPlace
valueAddress				There are no (further) constraints on this element Element Id Patient.extension:birthPlace.valueAddress:valueAddress
identifier		1..		There are no (further) constraints on this element Element Id Patient.identifier Sliced: Unordered, Open, by system(Value)
nationalPersonIdentifier		1..1		There are no (further) constraints on this element Element Id Patient.identifier:nationalPersonIdentifier
system		1..	Fixed Value	There are no (further) constraints on this element Element Id Patient.identifier:nationalPersonIdentifier.system Definition Swedish national OID for person identifiers Fixed Value urn:oid:1.2.752.129.2.1.3.1
value		1..		There are no (further) constraints on this element Element Id Patient.identifier:nationalPersonIdentifier.value
hospitalPatientIdentifier		..1		There are no (further) constraints on this element Element Id Patient.identifier:hospitalPatientIdentifier
system		1..	Fixed Value	There are no (further) constraints on this element Element Id Patient.identifier:hospitalPatientIdentifier.system Definition Swedish National OID for local system IDs Fixed Value urn:oid:1.2.752.129.2.1.2.1
value		1..		There are no (further) constraints on this element Element Id Patient.identifier:hospitalPatientIdentifier.value
name		1..1		There are no (further) constraints on this element Element Id Patient.name
family		1..		There are no (further) constraints on this element Element Id Patient.name.family
given		1..		There are no (further) constraints on this element Element Id Patient.name.given
gender		1..		There are no (further) constraints on this element Element Id Patient.gender
birthDate		1..		There are no (further) constraints on this element Element Id Patient.birthDate
address	I			There are no (further) constraints on this element Element Id Patient.address Constraints VJ-1:If the patient has a temporary address, the period this address is in use should be filled in (use='temp') implies period.exists()
use	I			There are no (further) constraints on this element Element Id Patient.address.use
period	I			There are no (further) constraints on this element Element Id Patient.address.period
communication				There are no (further) constraints on this element
extension				There are no (further) constraints on this element Element Id Patient.communication.extension Sliced: Unordered, Open, by url(Value)
communicationMethod		..1	Extension(code)	There are no (further) constraints on this element Element Id Patient.communication.extension:communicationMethod Data Type Extension(code) Extension URL http://inera.se/fhir/dstu3/StructureDefinition/CommunicationMedium
valueCode		1..	Binding	There are no (further) constraints on this element Element Id Patient.communication.extension:communicationMethod.valueCode:valueCode Binding WrittenSpokenBoth (required)

Textual representation

Patient
Definition	Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Cardinality	0...*
Alias	SubjectOfCare Client Resident
Invariants	dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty() dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty() dom-4: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-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
Mappings	rim:Entity. Role, or Act rim:Patient[classCode=PAT] cda:ClinicalDocument.recordTarget.patientRole w5:administrative.individual
Patient.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality	0...1
Type	id
Summary	True
Comments	The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.meta
Definition	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality	0...1
Type	Meta
Summary	True
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:N/A
Patient.implicitRules
Definition	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Cardinality	0...1
Type	uri
Modifier	True
Summary	True
Comments	Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.language
Definition	The base language in which the resource is written.
Cardinality	0...1
Type	code
Binding	A human language. languages (extensible)
Comments	Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.text
Definition	A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality	0...1
Type	Narrative
Alias	narrative, html, xhtml, display
Comments	Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:N/A rim:Act.text?
Patient.contained
Definition	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality	0...*
Type	Resource
Alias	inline resources, anonymous resources, contained resources
Comments	This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Mappings	rim:Entity. Role, or Act rim:N/A
Patient.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.extension:birthPlace
Definition	The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.
Cardinality	0...1
Type	Extension(Address)
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.extension:birthPlace.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.extension:birthPlace.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...0
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.extension:birthPlace.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Fixed Value	http://hl7.org/fhir/StructureDefinition/birthPlace
Mappings	rim:n/a rim:N/A
Patient.extension:birthPlace.valueAddress:valueAddress
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	0...1
Type	Address
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:N/A
Patient.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality	0...*
Type	Extension
Modifier	True
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.identifier
Definition	An identifier for this patient.
Cardinality	1...*
Type	Identifier
Summary	True
Requirements	Patients are almost always assigned specific numerical identifiers.
Slicing	Unordered, Open, by system(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier v2:PID-3 rim:id cda:.id w5:id
Patient.identifier:nationalPersonIdentifier
Definition	An identifier for this patient.
Cardinality	1...1
Type	Identifier
Summary	True
Requirements	Patients are almost always assigned specific numerical identifiers.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier v2:PID-3 rim:id cda:.id w5:id
Patient.identifier:nationalPersonIdentifier.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.identifier:nationalPersonIdentifier.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.identifier:nationalPersonIdentifier.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . identifier-use (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:N/A rim:Role.code or implied by context
Patient.identifier:nationalPersonIdentifier.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. identifier-type (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
Patient.identifier:nationalPersonIdentifier.system
Definition	Swedish national OID for person identifiers
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Fixed Value	urn:oid:1.2.752.129.2.1.3.1
Mappings	rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
Patient.identifier:nationalPersonIdentifier.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General 123456
Mappings	rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
Patient.identifier:nationalPersonIdentifier.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Comments	This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) per-1:If present, start SHALL have a lower value than end start.empty() or end.empty() or (start <= end)
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
Patient.identifier:nationalPersonIdentifier.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
Patient.identifier:hospitalPatientIdentifier
Definition	An identifier for this patient.
Cardinality	0...1
Type	Identifier
Summary	True
Requirements	Patients are almost always assigned specific numerical identifiers.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier v2:PID-3 rim:id cda:.id w5:id
Patient.identifier:hospitalPatientIdentifier.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.identifier:hospitalPatientIdentifier.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.identifier:hospitalPatientIdentifier.use
Definition	The purpose of this identifier.
Cardinality	0...1
Type	code
Binding	Identifies the purpose for this identifier, if known . identifier-use (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments	This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:N/A rim:Role.code or implied by context
Patient.identifier:hospitalPatientIdentifier.type
Definition	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality	0...1
Type	CodeableConcept
Binding	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. identifier-type (extensible)
Summary	True
Requirements	Allows users to make use of identifiers when the identifier system is not known.
Comments	This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
Patient.identifier:hospitalPatientIdentifier.system
Definition	Swedish National OID for local system IDs
Cardinality	1...1
Type	uri
Summary	True
Requirements	There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments	see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Fixed Value	urn:oid:1.2.752.129.2.1.2.1
Mappings	rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
Patient.identifier:hospitalPatientIdentifier.value
Definition	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality	1...1
Type	string
Summary	True
Comments	If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General 123456
Mappings	rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
Patient.identifier:hospitalPatientIdentifier.period
Definition	Time period during which identifier is/was valid for use.
Cardinality	0...1
Type	Period
Summary	True
Comments	This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) per-1:If present, start SHALL have a lower value than end start.empty() or end.empty() or (start <= end)
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
Patient.identifier:hospitalPatientIdentifier.assigner
Definition	Organization that issued/manages the identifier.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Comments	The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
Patient.active
Definition	Whether this patient record is in active use.
Cardinality	0...1
Type	boolean
Modifier	True
Summary	True
Requirements	Need to be able to mark a patient record as not to be used because it was created in error.
Comments	Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:statusCode cda:n/a w5:status
Patient.name
Definition	A name associated with the individual.
Cardinality	1...1
Type	HumanName
Summary	True
Requirements	Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
Comments	A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
Patient.name.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.name.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.name.use
Definition	Identifies the purpose for this name.
Cardinality	0...1
Type	code
Binding	The use of a human name name-use (required)
Modifier	True
Summary	True
Requirements	Allows the appropriate name for a particular context of use to be selected from among a set of names.
Comments	This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
Patient.name.text
Definition	A full text representation of the name.
Cardinality	0...1
Type	string
Summary	True
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and structured parts.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:implied by XPN.11 rim:./formatted
Patient.name.family
Definition	The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Cardinality	1...1
Type	string
Summary	True
Alias	surname
Comments	Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
Patient.name.given
Definition	Given name.
Cardinality	1...*
Type	string
Summary	True
Alias	first name, middle name
Comments	If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames
Patient.name.prefix
Definition	Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Cardinality	0...*
Type	string
Summary	True
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode
Patient.name.suffix
Definition	Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Cardinality	0...*
Type	string
Summary	True
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN/4 rim:./part[partType = SFX]
Patient.name.period
Definition	Indicates the period of time when this name was valid for the named person.
Cardinality	0...1
Type	Period
Summary	True
Requirements	Allows names to be placed in historical context.
Comments	This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) per-1:If present, start SHALL have a lower value than end start.empty() or end.empty() or (start <= end)
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
Patient.telecom
Definition	A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
Cardinality	0...*
Type	ContactPoint
Summary	True
Requirements	People have (primary) ways to contact them in some way such as phone, email.
Comments	A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) cpt-2:A system is required if a value is provided. value.empty() or system.exists()
Mappings	rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom
Patient.gender
Definition	Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
Cardinality	1...1
Type	code
Binding	The gender of a person used for administrative purposes. administrative-gender (required)
Summary	True
Requirements	Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.
Comments	The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:PID-8 rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode
Patient.birthDate
Definition	The date of birth for the individual.
Cardinality	1...1
Type	date
Summary	True
Requirements	Age of the individual drives many clinical processes.
Comments	At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:PID-7 rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8
Patient.deceased[x]
Definition	Indicates if the individual is deceased or not.
Cardinality	0...1
Type	boolean, dateTime
Modifier	True
Summary	True
Requirements	The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.
Comments	If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
Patient.address
Definition	Addresses for the individual.
Cardinality	0...*
Type	Address
Summary	True
Requirements	May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
Comments	Patient may have multiple addresses with different uses or applicable periods.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) VJ-1:If the patient has a temporary address, the period this address is in use should be filled in (use='temp') implies period.exists()
Mappings	rim:n/a v2:XAD rim:AD servd:Address v2:PID-11 rim:addr cda:.addr
Patient.address.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.address.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.address.use
Definition	The purpose of this address.
Cardinality	0...1
Type	code
Binding	The use of an address address-use (required)
Modifier	True
Summary	True
Requirements	Allows an appropriate address to be chosen from a list of many.
Comments	This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General home
Mappings	rim:n/a v2:XAD.7 rim:unique(./use) servd:./AddressPurpose
Patient.address.type
Definition	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Cardinality	0...1
Type	code
Binding	The type of an address (physical / postal) address-type (required)
Summary	True
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General both
Mappings	rim:n/a v2:XAD.18 rim:unique(./use) vcard:address type parameter
Patient.address.text
Definition	A full text representation of the address.
Cardinality	0...1
Type	string
Summary	True
Requirements	A renderable, unencoded form.
Comments	Can provide both a text representation and parts.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General 137 Nowhere Street, Erewhon 9132
Mappings	rim:n/a v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 rim:./formatted vcard:address label parameter
Patient.address.line
Definition	This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Cardinality	0...*
Type	string
Summary	True
Requirements	home | work | temp | old - purpose of this address.
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General 137 Nowhere Street
Mappings	rim:n/a v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) rim:AD.part[parttype = AL] vcard:street servd:./StreetAddress (newline delimitted)
Patient.address.city
Definition	The name of the city, town, village or other community or delivery center.
Cardinality	0...1
Type	string
Summary	True
Alias	Municpality
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General Erewhon
Mappings	rim:n/a v2:XAD.3 rim:AD.part[parttype = CTY] vcard:locality servd:./Jurisdiction
Patient.address.district
Definition	The name of the administrative area (county).
Cardinality	0...1
Type	string
Summary	True
Alias	County
Comments	District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General Madison
Mappings	rim:n/a v2:XAD.9 rim:AD.part[parttype = CNT | CPA]
Patient.address.state
Definition	Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
Cardinality	0...1
Type	string
Summary	True
Alias	Province, Territory
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XAD.4 rim:AD.part[parttype = STA] vcard:region servd:./Region
Patient.address.postalCode
Definition	A postal code designating a region defined by the postal service.
Cardinality	0...1
Type	string
Summary	True
Alias	Zip
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Examples	General 9132
Mappings	rim:n/a v2:XAD.5 rim:AD.part[parttype = ZIP] vcard:code servd:./PostalIdentificationCode
Patient.address.country
Definition	Country - a nation as commonly understood or generally accepted.
Cardinality	0...1
Type	string
Summary	True
Comments	ISO 3166 3 letter codes can be used in place of a full country name.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XAD.6 rim:AD.part[parttype = CNT] vcard:country servd:./Country
Patient.address.period
Definition	Time period when address was/is in use.
Cardinality	0...1
Type	Period
Summary	True
Requirements	Allows addresses to be placed in historical context.
Comments	This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) per-1:If present, start SHALL have a lower value than end start.empty() or end.empty() or (start <= end)
Examples	General { "start": "2010-03-23", "end": "2010-07-01" }
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XAD.12 / XAD.13 + XAD.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
Patient.maritalStatus
Definition	This field contains a patient's most recent marital (civil) status.
Cardinality	0...1
Type	CodeableConcept
Binding	The domestic partnership status of a person. marital-status (extensible)
Requirements	Most, if not all systems capture it.
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode
Patient.multipleBirth[x]
Definition	Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
Cardinality	0...1
Type	boolean, integer
Requirements	For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
Comments	Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
Patient.photo
Definition	Image of the patient.
Cardinality	0...*
Type	Attachment
Requirements	Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
Comments	When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment".
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) att-1:It the Attachment has data, it SHALL have a contentType data.empty() or contentType.exists()
Mappings	rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc cda:n/a
Patient.contact
Definition	A contact party (e.g. guardian, partner, friend) for the patient.
Cardinality	0...*
Type	BackboneElement
Requirements	Need to track people you can contact about the patient.
Comments	Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) pat-1:SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()
Mappings	rim:n/a rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a
Patient.contact.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.contact.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.contact.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.contact.relationship
Definition	The nature of the relationship between the patient and the contact person.
Cardinality	0...*
Type	CodeableConcept
Binding	The nature of the relationship between a patient and a contact person for that patient. HL7 v2 Value Set 0131 (extensible)
Requirements	Used to determine which contact person is the most relevant to approach, depending on circumstances.
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:NK1-7, NK1-3 rim:code cda:n/a
Patient.contact.name
Definition	A name associated with the contact person.
Cardinality	0...1
Type	HumanName
Requirements	Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
Comments	Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a
Patient.contact.telecom
Definition	A contact detail for the person, e.g. a telephone number or an email address.
Cardinality	0...*
Type	ContactPoint
Requirements	People have (primary) ways to contact them in some way such as phone, email.
Comments	Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) cpt-2:A system is required if a value is provided. value.empty() or system.exists()
Mappings	rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a
Patient.contact.address
Definition	Address for the contact person.
Cardinality	0...1
Type	Address
Requirements	Need to keep track where the contact person can be contacted per postal mail or visited.
Comments	Note: address is for postal addresses, not physical locations.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr cda:n/a
Patient.contact.gender
Definition	Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
Cardinality	0...1
Type	code
Binding	The gender of a person used for administrative purposes. administrative-gender (required)
Requirements	Needed to address the person correctly.
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:NK1-15 rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
Patient.contact.organization
Definition	Organization on behalf of which the contact is acting or for which the contact is working.
Cardinality	0...1
Type	Reference(Organization)
Requirements	For guardians or business related contacts, the organization is relevant.
Comments	References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
Patient.contact.period
Definition	The period during which this contact person or organization is valid to be contacted relating to this patient.
Cardinality	0...1
Type	Period
Comments	This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) per-1:If present, start SHALL have a lower value than end start.empty() or end.empty() or (start <= end)
Mappings	rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:effectiveTime cda:n/a
Patient.animal
Definition	This patient is known to be an animal.
Cardinality	0...1
Type	BackboneElement
Modifier	True
Summary	True
Requirements	Many clinical systems are extended to care for animal patients as well as human.
Comments	The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:player[classCode=ANM] cda:n/a
Patient.animal.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.animal.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.animal.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.animal.species
Definition	Identifies the high level taxonomic categorization of the kind of animal.
Cardinality	1...1
Type	CodeableConcept
Binding	The species of an animal. animal-species (example)
Summary	True
Requirements	Need to know what kind of animal.
Comments	If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-35 rim:code cda:n/a
Patient.animal.breed
Definition	Identifies the detailed categorization of the kind of animal.
Cardinality	0...1
Type	CodeableConcept
Binding	The breed of an animal. animal-breeds (example)
Summary	True
Requirements	May need to know the specific kind within the species.
Comments	Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-37 rim:playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code cda:n/a
Patient.animal.genderStatus
Definition	Indicates the current state of the animal's reproductive organs.
Cardinality	0...1
Type	CodeableConcept
Binding	The state of the animal's reproductive organs. animal-genderstatus (example)
Summary	True
Requirements	Gender status can affect housing and animal behavior.
Comments	Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:N/A rim:genderStatusCode cda:n/a
Patient.communication
Definition	Languages which may be used to communicate with the patient about his or her health.
Cardinality	0...*
Type	BackboneElement
Requirements	If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.
Comments	If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:LanguageCommunication cda:patient.languageCommunication
Patient.communication.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.communication.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.communication.extension:communicationMethod
Definition	Optional Extension Element - found in all resources.
Cardinality	0...1
Type	Extension(code)
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.communication.extension:communicationMethod.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.communication.extension:communicationMethod.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.communication.extension:communicationMethod.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Fixed Value	http://inera.se/fhir/dstu3/StructureDefinition/CommunicationMedium
Mappings	rim:n/a rim:N/A
Patient.communication.extension:communicationMethod.valueCode:valueCode
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Cardinality	1...1
Type	code
Binding	WrittenSpokenBoth (required)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:N/A
Patient.communication.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.communication.language
Definition	The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.
Cardinality	1...1
Type	CodeableConcept
Binding	A human language. languages (extensible)
Requirements	Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
Comments	The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, LAN-2 rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
Patient.communication.preferred
Definition	Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
Cardinality	0...1
Type	boolean
Requirements	People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.
Comments	This language is specifically identified for communicating healthcare information.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a v2:PID-15 rim:preferenceInd cda:.preferenceInd
Patient.generalPractitioner
Definition	Patient's nominated care provider.
Cardinality	0...*
Type	Reference(Organization | Practitioner)
Alias	careProvider
Comments	This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
Patient.managingOrganization
Definition	Organization that is the custodian of the patient record.
Cardinality	0...1
Type	Reference(Organization)
Summary	True
Requirements	Need to know who recognizes this patient record, manages and updates it.
Comments	There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:scoper cda:.providerOrganization
Patient.link
Definition	Link to another patient resource that concerns the same actual patient.
Cardinality	0...*
Type	BackboneElement
Modifier	True
Summary	True
Requirements	There are multiple usecases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.
Comments	There is no assumption that linked patient records have mutual links. This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:outboundLink cda:n/a
Patient.link.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...1
Type	string
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a
Patient.link.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.link.modifierExtension
Definition	May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality	0...*
Type	Extension
Modifier	True
Summary	True
Alias	extensions, user content, modifiers
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ext-1:Must have either extensions or value[x], not both extension.exists() != value.exists()
Mappings	rim:n/a rim:N/A
Patient.link.other
Definition	The other patient resource that the link refers to.
Cardinality	1...1
Type	Reference(Patient | RelatedPerson)
Summary	True
Comments	Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count()) ref-1:SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings	rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3, MRG-1 rim:id cda:n/a
Patient.link.type
Definition	The type of link between this patient resource and another patient resource.
Cardinality	1...1
Type	code
Binding	The type of link between this patient resource and another patient resource. link-type (required)
Summary	True
Comments	Note that FHIR strings may not exceed 1MB in size
Invariants	ele-1:All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
Mappings	rim:n/a rim:typeCode cda:n/a

Table

Patient		..
Patient.extension		..
Patient.extension	Extension	..
Patient.extension.valueAddress		..
Patient.identifier		1..
Patient.identifier		1..1
Patient.identifier.system		1..
Patient.identifier.value		1..
Patient.identifier		..1
Patient.identifier.system		1..
Patient.identifier.value		1..
Patient.name		1..1
Patient.name.family		1..
Patient.name.given		1..
Patient.gender		1..
Patient.birthDate		1..
Patient.address		..
Patient.address.use		..
Patient.address.period		..
Patient.communication		..
Patient.communication.extension		..
Patient.communication.extension	Extension	..1
Patient.communication.extension.valueCode		1..

JSON

{
    "resourceType": "StructureDefinition",
    "id": "cba34a83-f0e8-4647-84ea-4dccdb85af8c",
    "meta": {
        "lastUpdated": "2018-10-25T13:12:53.525+00:00"
    },
    "url": "http://inera.se/fhir/dstu3/StructureDefinition/ViktorTestPatient",
    "name": "ViktorTestPatient",
    "status": "draft",
    "date": "2018-10-25T13:12:51.4859148+00:00",
    "description": "Test resource used as part of the FHIR Profiling training course",
    "fhirVersion": "3.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Patient",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Patient.extension",
                "path": "Patient.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Patient.extension:birthPlace",
                "path": "Patient.extension",
                "sliceName": "birthPlace",
                "type":  [
                    {
                        "code": "Extension",
                        "profile": "http://hl7.org/fhir/StructureDefinition/birthPlace"
                    }
                ]
            },
            {
                "id": "Patient.extension:birthPlace.valueAddress:valueAddress",
                "path": "Patient.extension.valueAddress",
                "sliceName": "valueAddress"
            },
            {
                "id": "Patient.identifier",
                "path": "Patient.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1
            },
            {
                "id": "Patient.identifier:nationalPersonIdentifier",
                "path": "Patient.identifier",
                "sliceName": "nationalPersonIdentifier",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Patient.identifier:nationalPersonIdentifier.system",
                "path": "Patient.identifier.system",
                "definition": "Swedish national OID for person identifiers",
                "min": 1,
                "fixedUri": "urn:oid:1.2.752.129.2.1.3.1"
            },
            {
                "id": "Patient.identifier:nationalPersonIdentifier.value",
                "path": "Patient.identifier.value",
                "min": 1
            },
            {
                "id": "Patient.identifier:hospitalPatientIdentifier",
                "path": "Patient.identifier",
                "sliceName": "hospitalPatientIdentifier",
                "max": "1"
            },
            {
                "id": "Patient.identifier:hospitalPatientIdentifier.system",
                "path": "Patient.identifier.system",
                "definition": "Swedish National OID for local system IDs",
                "min": 1,
                "fixedUri": "urn:oid:1.2.752.129.2.1.2.1"
            },
            {
                "id": "Patient.identifier:hospitalPatientIdentifier.value",
                "path": "Patient.identifier.value",
                "min": 1
            },
            {
                "id": "Patient.name",
                "path": "Patient.name",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Patient.name.family",
                "path": "Patient.name.family",
                "min": 1
            },
            {
                "id": "Patient.name.given",
                "path": "Patient.name.given",
                "min": 1
            },
            {
                "id": "Patient.gender",
                "path": "Patient.gender",
                "min": 1
            },
            {
                "id": "Patient.birthDate",
                "path": "Patient.birthDate",
                "min": 1
            },
            {
                "id": "Patient.address",
                "path": "Patient.address",
                "constraint":  [
                    {
                        "key": "VJ-1",
                        "severity": "warning",
                        "human": "If the patient has a temporary address, the period this address is in use should be filled in",
                        "expression": "(use='temp') implies period.exists()"
                    }
                ]
            },
            {
                "id": "Patient.address.use",
                "path": "Patient.address.use",
                "condition":  [
                    "VJ-1"
                ]
            },
            {
                "id": "Patient.address.period",
                "path": "Patient.address.period",
                "condition":  [
                    "VJ-1"
                ]
            },
            {
                "id": "Patient.communication.extension",
                "path": "Patient.communication.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Patient.communication.extension:communicationMethod",
                "path": "Patient.communication.extension",
                "sliceName": "communicationMethod",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile": "http://inera.se/fhir/dstu3/StructureDefinition/CommunicationMedium"
                    }
                ]
            },
            {
                "id": "Patient.communication.extension:communicationMethod.valueCode:valueCode",
                "path": "Patient.communication.extension.valueCode",
                "sliceName": "valueCode",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSetReference": {
                        "reference": "http://inera.se/fhir/dstu3/valueSet/human-communication-methods"
                    }
                }
            }
        ]
    }
}

XML

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="cba34a83-f0e8-4647-84ea-4dccdb85af8c" />
    <meta>
        <lastUpdated value="2018-10-25T13:12:53.525+00:00" />
    </meta>
    <url value="http://inera.se/fhir/dstu3/StructureDefinition/ViktorTestPatient" />
    <name value="ViktorTestPatient" />
    <status value="draft" />
    <date value="2018-10-25T13:12:51.4859148+00:00" />
    <description value="Test resource used as part of the FHIR Profiling training course" />
    <fhirVersion value="3.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Patient" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" />
    <derivation value="constraint" />
    <differential>
        <element id="Patient.extension">
            <path value="Patient.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Patient.extension:birthPlace">
            <path value="Patient.extension" />
            <sliceName value="birthPlace" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/birthPlace" />
            </type>
        </element>
        <element id="Patient.extension:birthPlace.valueAddress:valueAddress">
            <path value="Patient.extension.valueAddress" />
            <sliceName value="valueAddress" />
        </element>
        <element id="Patient.identifier">
            <path value="Patient.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
        </element>
        <element id="Patient.identifier:nationalPersonIdentifier">
            <path value="Patient.identifier" />
            <sliceName value="nationalPersonIdentifier" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Patient.identifier:nationalPersonIdentifier.system">
            <path value="Patient.identifier.system" />
            <definition value="Swedish national OID for person identifiers" />
            <min value="1" />
            <fixedUri value="urn:oid:1.2.752.129.2.1.3.1" />
        </element>
        <element id="Patient.identifier:nationalPersonIdentifier.value">
            <path value="Patient.identifier.value" />
            <min value="1" />
        </element>
        <element id="Patient.identifier:hospitalPatientIdentifier">
            <path value="Patient.identifier" />
            <sliceName value="hospitalPatientIdentifier" />
            <max value="1" />
        </element>
        <element id="Patient.identifier:hospitalPatientIdentifier.system">
            <path value="Patient.identifier.system" />
            <definition value="Swedish National OID for local system IDs" />
            <min value="1" />
            <fixedUri value="urn:oid:1.2.752.129.2.1.2.1" />
        </element>
        <element id="Patient.identifier:hospitalPatientIdentifier.value">
            <path value="Patient.identifier.value" />
            <min value="1" />
        </element>
        <element id="Patient.name">
            <path value="Patient.name" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Patient.name.family">
            <path value="Patient.name.family" />
            <min value="1" />
        </element>
        <element id="Patient.name.given">
            <path value="Patient.name.given" />
            <min value="1" />
        </element>
        <element id="Patient.gender">
            <path value="Patient.gender" />
            <min value="1" />
        </element>
        <element id="Patient.birthDate">
            <path value="Patient.birthDate" />
            <min value="1" />
        </element>
        <element id="Patient.address">
            <path value="Patient.address" />
            <constraint>
                <key value="VJ-1" />
                <severity value="warning" />
                <human value="If the patient has a temporary address, the period this address is in use should be filled in" />
                <expression value="(use=&#39;temp&#39;) implies period.exists()" />
            </constraint>
        </element>
        <element id="Patient.address.use">
            <path value="Patient.address.use" />
            <condition value="VJ-1" />
        </element>
        <element id="Patient.address.period">
            <path value="Patient.address.period" />
            <condition value="VJ-1" />
        </element>
        <element id="Patient.communication.extension">
            <path value="Patient.communication.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Patient.communication.extension:communicationMethod">
            <path value="Patient.communication.extension" />
            <sliceName value="communicationMethod" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://inera.se/fhir/dstu3/StructureDefinition/CommunicationMedium" />
            </type>
        </element>
        <element id="Patient.communication.extension:communicationMethod.valueCode:valueCode">
            <path value="Patient.communication.extension.valueCode" />
            <sliceName value="valueCode" />
            <min value="1" />
            <binding>
                <strength value="required" />
                <valueSetReference>
                    <reference value="http://inera.se/fhir/dstu3/valueSet/human-communication-methods" />
                </valueSetReference>
            </binding>
        </element>
    </differential>
</StructureDefinition>