Example
StructureDefinition/ParticipantContactable
(XML)
Raw
JSON
XML
(
canonical
form
+
also
see
XML
Format
Specification
)
When
the
value
set
version
should
no
longer
be
used
Logical
Model
ParticipantContactable
{
"resourceType": "StructureDefinition",
"id": "valueset-expirationDate",
"url": "http://hl7.org/fhir/StructureDefinition/valueset-expirationDate",
"name": "When the value set version should no longer be used",
"publisher": "HL7",
"description": "The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"type": "extension",
"abstract": false,
"contextType": "resource",
"context": [
"ValueSet"
],
"base": "http://hl7.org/fhir/StructureDefinition/Extension",
"snapshot": {
"element": [
{
"path": "Extension",
"short": "When the value set version should no longer be used",
"definition": "The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.extension",
"short": "Additional Content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"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 should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-expirationDate",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.valueDate",
"short": "Value of extension",
"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).",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Extension",
"short": "When the value set version should no longer be used",
"definition": "The date when the value set version is no longer expected to be used to create new content. This is the first date-time when the value set version becomes Inactive, so this value MUST present on all Inactive value set versions. The start Date_time is expected to be as of 0001 UTC of the Expiration Date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-expirationDate"
},
{
"path": "Extension.value[x]",
"type": [
{
"code": "date"
}
]
}
]
}
}
<?xml version="1.0" encoding="UTF-8"?>
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ParticipantContactable"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">to do</div>
</text>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="informative"/>
</extension>
<url value="http://hl7.org/fhir/StructureDefinition/ParticipantContactable"/>
<version value="5.0.0-ballot"/>
<name value="ParticipantContactable"/>
<title value="participantcontactable"/>
<status value="draft"/>
<experimental value="false"/>
<date value="2022-09-10T04:52:37+10:00"/>
<publisher value="Health Level Seven International fhir"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/fhir"/>
</telecom>
</contact>
<description value="Logical Model: A pattern followed by resources that represent a participant that
can be contacted."/>
<fhirVersion value="5.0.0-ballot"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="ParticipantContactable"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<snapshot>
<element id="ParticipantContactable">
<path value="ParticipantContactable"/>
<short value="Contactable Participant Pattern"/>
<definition value="A pattern followed by resources that represent a participant that can be contacted."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="ParticipantContactable"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="false"/>
<mapping>
<identity value="rim"/>
<map value="Role"/>
</mapping>
</element>
<element id="ParticipantContactable.telecom">
<path value="ParticipantContactable.telecom"/>
<short value="A contact detail for the participant"/>
<definition value="A contact detail (e.g. a telephone number or an email address) by which the participant
may be contacted."/>
<requirements value="Participants have (primary) ways to contact them in some way such as phone, email."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="ParticipantContactable.telecom"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="ContactPoint"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value=".identifier"/>
</mapping>
</element>
<element id="ParticipantContactable.address">
<path value="ParticipantContactable.address"/>
<short value="An address for the individual"/>
<definition value="An address for the participant."/>
<requirements value="May need to keep track of participant addresses for contacting, billing or reporting
requirements and also to help with identification."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="ParticipantContactable.address"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Address"/>
</type>
<constraint>
<key value="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression value="hasValue() or (children().count() > id.count())"/>
<xpath value="@value|f:*|h:div"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<isSummary value="true"/>
<mapping>
<identity value="rim"/>
<map value=".status"/>
</mapping>
</element>
</snapshot>
</
StructureDefinition
>
Usage
note:
every
effort
has
been
made
to
ensure
that
the
examples
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
specification.
Workflow
|
Propose
a
change